Einleitung
Diese Dokumentation ist für Web-Entwickler gedacht, die unsere API z.B. zum Abrufen von Klienten-Details für die Agentur-Website nutzen möchten. Bei Rückfragen zur API oder zur Dokumentation stehen wir Ihnen gerne zur Verfügung.
Die API ist unter https://api.etalenta.eu/ erreichbar.
Es handelt sich um eine REST-API, die JSON-Daten (UTF-8 kodiert) zurückliefert.
Authorisierung
Der Zugriff auf die API erfolgt über einen Access-Token, der bei jedem Aufruf als Header „API-ACCESS-TOKEN“ mitgeschickt werden muss.
Um Ihren Access-Token für den Zugriff auf API zu erhalten, wenden Sie sich bitte an uns.
Funktionen
Klienten-Liste abrufen
Parameter: language (optional, mögliche Werte: DE, EN, ES, FR, IT, PL, RU)
Aufruf (GET): https://api.etalenta.eu/getProfileList/{language}
Rückgabe: Array mit JSON-Objects
- id: eindeutige ID des Klienten
- gn: Vorname des Klienten
- sn: Nachname des Klienten
- gender: Geschlecht des Klienten (m, f, d)
- timestamp: Zeitstempel der letzten Änderung
- type: Berufsbezeichnungen, Array mit JSON-Objects (catalogueId: ID der Bezeichnung, label: Berufsbezeichnung als String)
Klienten-Details abrufen
Parameter: ID des Klienten, language (optional, mögliche Werte: DE, EN, ES, FR, IT, PL, RU)
Aufruf (GET): https://api.etalenta.eu/getProfile/{id}/{language}
Rückgabe: JSON-Object mit Klientendaten
- Feldbeschreibung folgt
Foto eines Klienten abrufen
Parameter: fotoId des Fotos, width (optional), height (optional)
Sind keine Werte für width oder height gesetzt, dann wird das Foto in Originalgröße zurückgegeben. Sind Werte gesetzt, gelten diese als maximales Maß, d.h. das Seiteiverhältnis wird beibehalten und das Foto passt in die angegebenen Grenzen.
Aufruf (GET): https://api.etalenta.eu/getFoto/{fotoId}/{width}/{height}
Rückgabe: JPEG Bilddaten (Content-Type: image/jpeg)
Hashwert eines Klienten-Fotos abrufen
Mit dieser Funktion kann der Original SHA1-Hashwert eines Fotos abgerufen werden, um z.B. nach dem Download die Konsistenz der lokalen Datei zu prüfen oder um doppelte Fotos zu erkennen.
Parameter: fotoId des Fotos
Aufruf (GET): https://api.etalenta.eu/getFotoHash/{fotoId}
Rückgabe: SHA1-Hashwert des Fotos
Vita-PDF eines Klienten abrufen
Um diese Funktion nutzen zu können, muss in der Agentursoftware das entsprechende Vita-Layout hinterlegt sein.
Parameter: id des Klienten, language (mögliche Werte: DE, EN, ES, FR, IT, PL, RU)
Aufruf (GET): https://api.etalenta.eu/getVitaPdf/{id}/{language}
Rückgabe: PDF Daten (Content-Type: application/pdf)
Website-News abrufen
Über die Agentursoftware können Newsmeldungen für Klienten gepflegt werden. Diese Newsmeldungen können über diesen Aufruf abgerufen werden.
Parameter: keine
Aufruf (GET): https://api.etalenta.eu/getWebsiteNews
Rückgabe: Array mit JSON-Objects
- rowId: eindeutige ID der Newsmeldung
- profileId: ID des zugehörigen Klienten
- gn: Vorname des zugehörigen Klienten
- sn: Name des zugehörigen Klienten
- title: Überschrift, Freitext aus Pflegebereich der Agentursoftware
- teaser: Teaser-Text, Freitext aus Pflegebereich der Agentursoftware
- body: Text, Freitext aus Pflegebereich der Agentursoftware
- date: Datum, Freitext aus Pflegebereich der Agentursoftware
- time: Zeit, Freitext aus Pflegebereich der Agentursoftware
- station: Sender, Freitext aus Pflegebereich der Agentursoftware
- hidden: gibt an, ob die Newsmeldung ausgeblendet werden soll (true/false)
- featured: entspricht der Checkbox „featured“ beim Pflegen der Newsmeldung, kann z.B. genutzt werden, um einzelne Newsmeldungen hervorzuheben (true/false)
- position: Position für die Sortierung
- timestampUpdate: Zeitstempel der letzten Änderung
- foto: JSON-Object mit Foto-Details, wenn ein spezielles Foto mit der Newsmeldung verknüpft ist (enabled: true/false – gibt an ob ein Foto verknüpft wurde, fotoId: ID des Fotos, copyright: Copyright des Fotos)