Der Begriff API ist eine Abkürzung für "Application Program Interface" und ist ein Sammelbegriff für Protokolle, Vorgehensweise und Tools im Entwicklungsprozess von Software.
Um ein API Statement zu generieren benötigt ihr den Befehl GET - über unsere unterstützten APIs könnt ihr dann die gewünschten Inhalte abrufen.
Da wir nach einigen Beispiel-Calls immer wieder gefragt werden, haben wir die drei häufigsten hier aufgelistet.
1. Wie lautet der API Call um eine Liste aller Abonnenten einer Seite abzurufen?
Das API Statement um eine Liste der Nutzer, die eine Seite abonniert haben, zu generieren, lautet wie folgt:
GET auf /api/users/USER_ID/subscriptions
Hinweis:
Seit dem Cloudrelease 22 könnt ihr als Seitenadmin direkt auf der Seite die Abonnenten einsehen.
2. Wie kann ich mit Hilfe der die API über einen Feldinhalt eine Suche ausführen?
Per API-Statement kann nur das gesamte Benutzer Objekt ausgeworfen werden. Dieses enthält aber die ID. Der Beispiel-Befehl lautet wie folgt und beinhaltet diese Parameter:
Welches Feld = searchFields=email
SucherTerm= term=<email-addresse>
GET https://<eure-coyo-domain>/api/users?searchFields=email&term=<email-address>&_page=0&_pageSize=10
cURL Beispiel:
curl -X
GET
https://<eure-coyo-domain>/api/users?searchFields=email&term=<email-address>&_page=0&_pageSize=10
-H
authorization: Bearer <token>3. Wie kann per API Statement das Feld "Verzeichnis" der Benutzerverwaltung ausgelesen werden?
Mit dem folgendem GET Befehl ist es möglich, eine Liste aller Benutzer inklusive aller Felder auszugeben:
GET /api/users?with=adminFields
... und was kann ich nicht abrufen?
Für einige Felder ist keine Anpassung per API möglich.
Diese sind:
Diese sind:
- Properties
- Anpassung eines Pflichtfeldes als "Nichtpflichtfeld"
Aufgrund des technischen Inhalts sind viele Begriffe und Befehle in diesem Artikel auf Englisch.