Anfragen
Last updated
Last updated
Der Host für Anfragen an Web API v1 ist immer https://api.iafcertsearch.org/api/client/v1
Sie müssen einen Autorisierungs-Header bereitstellen, wie in beschrieben.
GET
Ressource oder Gruppe von Ressourcen abrufen
POST
Neue Ressource erstellen
PUT
Vorhandene Ressource aktualisieren
DELETE
Vorhandene Ressource löschen
OPTIONS
Erlaubte Verben für eine spezifische Ressource anzeigen
Die API liefert JSON-Antworten. Der accept-Header wird derzeit nicht benötigt, könnte dies jedoch in Zukunft sein. Wenn er nicht gesetzt ist, wird die API application/json
verwenden.
Wenn Sie ein Datenarray in einer GET
-Anfrage senden, müssen Sie den Parameter mehrmals in der URL angeben. Der Parametername benötigt keine Klammern.
Wenn Sie Daten über POST
oder PUT
an eine Ressource senden, müssen Sie Ihre Nutzlast als JSON senden.
Einige GET
-Ressourcen ermöglichen das Abrufen von Informationen in Stapeln. Wir geben die Abfragemöglichkeiten in der Ressourcendokumentation an, sofern zutreffend.
Wenn Sie mehrere Elemente anfordern, setzen wir die Anfragebeschränkung standardmäßig auf 20
Elemente. Sie können eine andere Beschränkung mithilfe des limit
-Parameters angeben, wenn dies erforderlich ist. Der maximale Wert für den limit
-Parameter, den wir akzeptieren, beträgt 100
.
Nachfolgend sehen Sie ein Beispiel für eine API-Anfrage, bei der die ersten 100 Datensätze gemäß den Parametern limit=100
und offset=0
abgerufen werden.
Um die nächste Stapel von Datensätzen abzurufen, erhöhen Sie den Wert des offset-Parameters um 1
.
Verb
Zurückgegebenes Ressourcenobjekt
GET
Gibt ein einzelnes Ressourcenobjekt oder ein Array von Ressourcenobjekten zurück
PATCH
Gibt das aktualisierte Ressourcenobjekt zurück
PUT
Gibt das aktualisierte Ressourcenobjekt zurück
DELETE
Es wird kein Inhalt zurückgegeben
POST
Gibt das neu erstellte Ressourcenobjekt zurück