Katalog der Webdienste
Der online Katalog der Webdienste ist ein gemeinsamer Ort, an dem die API-Dokumentation zu finden ist.
In diesem Rahmen können Sie verschiedene Methoden lesen, kopieren und testen und sie an Ihre Bedürfnisse anpassen.
Inhaltsverzeichnis
- Header
- Parameter
- Antworten
- Schemas
|
1. Header
Der Header eines einzelnen PANTHEON API-Beispiels enthält Informationen darüber, welche Operationsmethode verwendet wird, den API-Endpunkt relativ zur Basis-URL, die Beschreibung einer angezeigten Aktion und ein funktionierendes Beispiel einer Abfrage:
- Verwendete Operationsmethoden
- Endpunkt
- Beschreibung
- Beispiel einer Abfrage
Operationsmethoden in der PANTHEON API:
|
|
Ruft Daten vom Server ab.
|
|
|
Erstellt neue Datensätze in der Datenbank oder ruft Daten vom Server ab.
|
|
|
Aktualisiert vorhandene Datensätze.
|
2. Parameter
In den Parameternwird ein Beispiel einer Abfrage ohne Werte angezeigt.
Durch Klicken auf die Probieren Sie es aus Schaltfläche öffnet sich der Abfrage-Editor und Sie können Ihre eigenen Abfragen vorbereiten.
Nachdem die Daten oder die Abfrage eingegeben wurden, können Sie die Methode ausführen, indem Sie die Ausführen Schaltfläche auswählen. Wenn Sie den Editor verlassen möchten, wählen Sie die Abbrechen Schaltfläche.
2.1 Parameterfeld
In einigen APIs können Daten auch im Parameter Feld eingegeben werden:
2.1.1 Eingabefeld
Im Parameterfeld Ident, können Sie Ihr Element eingeben.
2.1.2 Anfragekörper
Im Anfragekörper können Sie Ihre Abfrage eingeben oder die Beispielabfrage bearbeiten.
3. Antworten
In den Antworten werden die Ergebnisse angezeigt, nachdem die Abfrage ausgeführt wurde.
Antworten beinhaltet:
- cURL
- Anforderungs-URL
- Serverantwort
3.1 cURL
Enthält ein cURL-Befehlszeilenwerkzeug mit den Parametern der ausgeführten Abfrage. Mit dem Symbol "In die Zwischenablage kopieren" in der rechten unteren Ecke können Sie die cURL-Zeile einfach in die Zwischenablage kopieren.
3.2 Anforderungs-URL
Enthält die URL, die von der Methode verwendet wurde. Sie besteht aus einer HTTPS-Methode, einer Basis-URL und einem Endpunkt oder Ressourcen-URI.
3.3 Serverantwort
Zeigt die Ergebnisse einer erfolgreich ausgeführten Abfrage an.
Antwort-Header enthalten Informationen über den Inhaltstyp, Zeichensatz, Zeit und Server der ausgeführten Abfrage.
Im Antwortkörper, werden die Ergebnisse im JSON-Format präsentiert. Sie können in die Zwischenablage kopiert oder als .json-Datei heruntergeladen werden, indem Sie die entsprechende Schaltfläche in der rechten unteren Ecke auswählen.
Die in den Antworten angezeigten Codes zeigen den Status der ausgeführten Abfrage an.
|
200
|
Erfolg: erfolgreich ausgeführt.
|
|
500
|
Fehler: Beschreibung eines Fehlers.
|
4. Schemas
Schemas enthalten Informationen über die Datenstruktur von Objekten.
Ein spezifisches Schema liefert eine Beschreibung des angegebenen Objekts.
