Connettore di dati#

Il connettore di dati popola un sito NAMES LEGAL con dati che esistono già altrove, senza codice da parte del titolare del sito. Il titolare collega una fonte nella propria console (Integrazioni → Importa i miei dati), collega le colonne ai campi trascinandole, esegue una prova e avvia. Le fonti possono essere file o un'API — la Sua.

Questa pagina è per gli sviluppatori di applicazioni che desiderano diventare una fonte: cosa si aspetta NAMES LEGAL dalla Sua API e come rendere automatico il collegamento.

Come il connettore legge la Sua API#

Il titolare del sito inserisce:

• l'indirizzo della Sua API,
• una modalità di autenticazione e il relativo secret,
• facoltativamente, dove si trova l'elenco nella Sua risposta (data.items).

NAMES LEGAL chiama quindi la Sua API tramite HTTPS con GET, segue la paginazione e trasforma ogni oggetto in una scheda. Gli oggetti annidati vengono appiattiti (author.name), gli elenchi di valori semplici vengono uniti con virgole.

Autenticazione#

I secret vengono memorizzati crittografati e non vengono più mostrati nella console. Fornisca ai titolari dei siti una chiave di sola lettura limitata al contenuto pubblicato: il connettore legge soltanto.

Individuazione dell'elenco#

Se non viene fornito alcun percorso, il connettore utilizza, in ordine: l'array items, quindi il primo array di oggetti trovato nella risposta. Funziona anche un semplice array JSON.

Paginazione#

Uno qualsiasi dei seguenti metodi viene seguito automaticamente, fino a 200 pagine:

• un'intestazione HTTP Link: <…>; rel="next";
• un URL della pagina successiva nel corpo: next, next_url, next_page_url, links.next, meta.next, pagination.next;
• un cursore nel corpo: next_cursor, meta.next_cursor, pagination.next_cursor — rinviato come ?cursor=.

Si interrompe restituendo un elenco vuoto o nessun link successivo.

Limiti#

• 5.000 schede per set di dati e sincronizzazione.
• 10 MB per risposta, 15 secondi per richiesta.
• Gli indirizzi devono essere pubblici: indirizzi privati e di rete locale vengono rifiutati, reindirizzamenti inclusi. In caso di reindirizzamento verso un altro host, la Sua chiave non viene inoltrata.

Il formato feed di NAMES LEGAL#

Esponga i Suoi dati in questo formato e il titolare del sito non avrà nulla da collegare: ogni raccolta diventa un set di dati già collegato alla sezione corrispondente del sito.

1. Un indice#

GET https://app.example.com/api/names-legal/

{
  "names_legal_feed": 1,
  "collections": {
    "team": "https://app.example.com/api/names-legal/team/",
    "services": "https://app.example.com/api/names-legal/programmes/",
    "blog": "https://app.example.com/api/names-legal/news/"
  }
}

I nomi delle raccolte sono le chiavi di sezione elencate nel riferimento dei campi più sotto (team, services, blog, events, faq, jobs…). Gli URL possono essere relativi all'indice.

2. Un elenco per ciascuna raccolta#

{
  "items": [
    {
      "id": "T-104",
      "first_name": "Awa",
      "last_name": "Diop",
      "position": "Mathematics teacher",
      "short_bio": "Twelve years of teaching.",
      "profile_image": "https://app.example.com/media/staff/104.jpg",
      "email": "a.diop@example.com"
    }
  ],
  "next": null
}

Regole:

• id — un identificatore stabile, diverso per ogni scheda. È ciò che permette a una scheda modificata di aggiornare la stessa voce invece di crearne una nuova.
• I nomi dei campi sono quelli del riferimento dei campi.
• I campi tradotti hanno una chiave per ogni lingua: title_fr, title_en, description_de… Una chiave senza suffisso va alla lingua predefinita del sito.
• Immagini e file sono URL pubblici. Vengono scaricati una volta e scaricati di nuovo solo quando l'URL cambia. I link di condivisione di Google Drive e Dropbox sono accettati.
• Le categorie sono indicate per nome ("category": "Bachelor"); le categorie mancanti vengono create.
• Le date sono in ISO 8601. I booleani sono true/false.
• I campi di testo formattato accettano HTML; viene ripulito (nessuno script, nessun gestore di eventi). Il testo semplice diventa paragrafi.
• Restituisca solo ciò che può essere pubblicato: bozze e dati privati non dovrebbero comparire nel feed.

Mantenere il sito aggiornato#

Il titolare del sito sceglie, per ciascuna sezione:

Scelgono inoltre cosa succede quando una scheda è cambiata da entrambe le parti (vincono i Suoi dati, vince il sito, oppure viene chiesto), e cosa succede quando una scheda scompare dal Suo feed (eliminazione dal sito, occultamento, o conservazione). Una sincronizzazione che rimuoverebbe una quota rilevante di una sezione si interrompe e chiede prima conferma.

La scrittura verso la Sua applicazione ("il mio sito → la mia fonte") non è ancora disponibile: il connettore legge soltanto.

Riferimento dei campi#

Generato direttamente dalla piattaforma; è sempre aggiornato. I campi obbligatori devono essere presenti in ogni scheda (per un campo tradotto, in almeno una lingua).

Dimensione della squadra team

Servizi services

Progetti projects

Blog / notizie blog

Eventi events

FAQ faq

Offerte di lavoro jobs

Risorse resources

Pubblicazioni publications

Testimonianze testimonials

Competenze skills

Cifre chiave stats