Datenkonnektor#

Der Datenkonnektor befüllt eine NAMES LEGAL-Website mit Daten, die bereits anderswo existieren, ohne Code auf Seiten des Website-Inhabers. Der Inhaber verbindet eine Quelle in seiner Konsole (Integrationen → Meine Daten importieren), verknüpft Spalten per Drag-and-drop mit Feldern, führt einen Probelauf durch und startet. Quellen können Dateien oder eine API sein – Ihre.

Diese Seite richtet sich an Entwickler von Anwendungen, die als Quelle fungieren möchten: was NAMES LEGAL von Ihrer API erwartet und wie Sie die Verbindung automatisch gestalten.

Wie der Konnektor Ihre API liest#

Der Website-Inhaber gibt ein:

• die Adresse Ihrer API,
• einen Authentifizierungsmodus und dessen Geheimnis,
• optional, wo sich die Liste in Ihrer Antwort befindet (data.items).

NAMES LEGAL ruft daraufhin Ihre API über HTTPS mit GET auf, folgt der Paginierung und wandelt jedes Objekt in eine Zeile um. Verschachtelte Objekte werden abgeflacht (author.name), Listen einfacher Werte werden durch Kommas verbunden.

Authentifizierung#

Geheimnisse werden verschlüsselt gespeichert und in der Konsole nie wieder angezeigt. Geben Sie Website-Inhabern einen schreibgeschützten Schlüssel, der auf veröffentlichte Inhalte beschränkt ist: Der Konnektor liest nur.

Die Liste finden#

Wenn kein Pfad angegeben ist, nimmt der Konnektor in dieser Reihenfolge: das Array items, dann das erste in der Antwort gefundene Array von Objekten. Ein reines JSON-Array funktioniert ebenfalls.

Paginierung#

Jedes der folgenden wird automatisch verfolgt, bis zu 200 Seiten:

• ein HTTP-Link: <…>; rel="next"-Header;
• eine URL zur nächsten Seite im Body: next, next_url, next_page_url, links.next, meta.next, pagination.next;
• ein Cursor im Body: next_cursor, meta.next_cursor, pagination.next_cursor — wird als ?cursor= zurückgesendet.

Stoppen Sie, indem Sie eine leere Liste oder keinen Next-Link zurückgeben.

Grenzwerte#

• 5.000 Zeilen pro Datensatz und Synchronisierung.
• 10 MB pro Antwort, 15 Sekunden pro Anfrage.
• Adressen müssen öffentlich sein: private und lokale Netzwerkadressen werden abgelehnt, Weiterleitungen eingeschlossen. Bei einer Weiterleitung auf einen anderen Host wird Ihr Schlüssel nicht weitergegeben.

Das NAMES LEGAL-Feed-Format#

Stellen Sie Ihre Daten in diesem Format bereit, und der Website-Inhaber hat nichts zu verknüpfen: Jede Sammlung wird zu einem Datensatz, der bereits mit dem passenden Bereich der Website verbunden ist.

1. Ein Index#

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/"
  }
}

Sammlungsnamen sind die Bereichsschlüssel, die in der Feldreferenz unten aufgeführt sind (team, services, blog, events, faq, jobs…). URLs können relativ zum Index sein.

2. Eine Liste pro Sammlung#

{
  "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
}

Regeln:

• id — eine stabile Kennung, die in jeder Zeile unterschiedlich ist. Sie sorgt dafür, dass eine bearbeitete Zeile denselben Eintrag aktualisiert, statt einen neuen zu erstellen.
• Feldnamen entsprechen denen der Feldreferenz.
• Übersetzte Felder haben einen Schlüssel pro Sprache: title_fr, title_en, description_de… Ein Schlüssel ohne Suffix geht an die Standardsprache der Website.
• Bilder und Dateien sind öffentliche URLs. Sie werden einmal heruntergeladen und nur erneut heruntergeladen, wenn sich die URL ändert. Freigabelinks von Google Drive und Dropbox werden akzeptiert.
• Kategorien werden mit Namen angegeben ("category": "Bachelor"); fehlende Kategorien werden erstellt.
• Daten sind im Format ISO 8601. Boolesche Werte sind true/false.
• Rich-Text-Felder akzeptieren HTML; es wird bereinigt (keine Skripte, keine Event-Handler). Klartext wird zu Absätzen.
• Geben Sie nur zurück, was veröffentlicht werden darf: Entwürfe und private Daten sollten nicht im Feed erscheinen.

Die Website aktuell halten#

Der Website-Inhaber wählt pro Bereich:

Sie wählen außerdem, was passiert, wenn sich ein Eintrag auf beiden Seiten geändert hat (Ihre Daten gewinnen, die Website gewinnt, oder nachfragen), und wenn eine Zeile aus Ihrem Feed verschwindet (auf der Website löschen, ausblenden oder behalten). Eine Synchronisierung, die einen großen Teil eines Bereichs entfernen würde, stoppt und fragt zunächst um Bestätigung.

Das Zurückschreiben in Ihre Anwendung ("meine Website → meine Quelle") ist noch nicht verfügbar: Der Konnektor liest nur.

Feldreferenz#

Wird von der Plattform selbst generiert; sie ist stets aktuell. Erforderliche Felder müssen in jeder Zeile vorhanden sein (bei einem übersetzten Feld in mindestens einer Sprache).

Team team

Dienstleistungen services

Projekte projects

Blog / Neuigkeiten blog

Veranstaltungen events

FAQ faq

Stellenangebote jobs

Ressourcen resources

Veröffentlichungen publications

Kundenstimmen testimonials

Fähigkeiten skills

Kennzahlen stats