Die erste Anfrage an die API senden
Für alle, die selbst programmieren. Die API antwortet mit JSON, und jede Anfrage trägt den Schlüssel im Header.
ab Professional Teil des Plugins „API“. Ein Plugin installieren · Tarife vergleichen
Schritt 1 von 3
API-Adresse kopieren
Die Adresse Ihrer API steht in den Einstellungen unter den Schlüsseln.
-
1
Öffnen Sie Einstellungen → „API“.
-
2
Klicken Sie unter „Für Entwickler“ auf „API-Adresse“. Vendority kopiert die Adresse und meldet „Adresse kopiert“.
-
3
Die Adresse endet auf
/api, zum Beispielhttps://ihr-betrieb.vendority.io/api.
Schritt 2 von 3
Anfrage senden
Bei jeder Anfrage senden Sie den Schlüssel im Authorization-Header mit.
-
1
Öffnen Sie ein Terminal.
-
2
Senden Sie diese Anfrage, mit Ihrer Adresse und Ihrem Schlüssel:
curl -X POST https://ihr-betrieb.vendority.io/api/invoices -H "Authorization: Bearer vdy_…" -H "Content-Type: application/json" -d '{}' -
3
Die Antwort nennt unter
totalItemsdie Zahl Ihrer Rechnungen und liefert unteritemsdie ersten 50. -
4
Kommt
401zurück, ist der Schlüssel falsch oder abgelaufen. -
5
Kommt
403zurück, darf der Schlüssel keine Rechnungen sehen.
Schritt 3 von 3
API-Referenz öffnen
Die Referenz beschreibt alle Endpunkte, mit Beispielen zum Ausprobieren.
-
1
Klicken Sie in Einstellungen → „API“ unter „Für Entwickler“ auf „API-Referenz“.
-
2
Die Referenz liegt unter der Adresse Ihrer API mit
/docs, also etwahttps://ihr-betrieb.vendority.io/api/docs. -
3
Klappen Sie einen Endpunkt auf, um Parameter, Beispiele und mögliche Antworten zu sehen.
Geschafft.
Sie haben „Die erste Anfrage an die API senden“ von Anfang bis Ende durchgearbeitet.
Blättern auch mit ← und →