Webcockpit Knowledge Base

Durchsuchen Sie die gesamte Dokumentation.

API Management

Dokumentation zur API-Konfiguration und Zugriffsverwaltung.

Beschreibung

Über Webcockpit Connect (REST-API)

Webcockpit REST-API ermöglicht den programmatischen Zugriff auf Restaurant Daten (REST Wikipedia). Webcockpit APIs werden unabhängig von den bestehenden Webcockpit Berichten und Apps gepflegt und weiterentwickelt. Neue APIs implementieren wir auf Anfrage.

Verfügbarkeit

Abonnement
Pro
Umfang
Alle Märkte
Einschränkung
Nur für Benutzer in der Rolle „Organisations-Administrator"

Informationen

Dieses Kapitel enthält Informationen über die verfügbaren Endpunkte, darüber, wie ein API Key erzeugt wird und wie ein Endpunkt aufgerufen werden kann.

API Endpunkte

Webcockpit REST-API folgt der OpenAPI Specification – Version 3. Alle verfügbaren API Anfragen und deren Datenmodelle sind auf der unten genannten Seite dokumentiert.

Dokumentation: https://api.webcockpit.app/swagger/index.html

API Endpunkt aufrufen

API Endpunkte können z.B. mit dem Programm Postman getestet werden.

Einstellungen Header

  • Key: X-Api-Key
  • Value: [API Key]

Einstellungen Body

  • Typ: raw / JSON

Beispiel

json 
https://api.webcockpit.app/api/api/Default/getsalesperbusinessday
{
  "StoreId":"12345",
  "From":"2020-08-29T00:00:00.000Z",
  "To":"2020-08-31T00:00:00.000Z",
  "CountryCode":"XY"
}

API Key erzeugen und verwalten

Navigationsmenu in der Sektion „Administrator”.

Verwenden Sie den Button „Token hinzufügen”, um einen neuen API Key zu erzeugen. Im Anschluss weisen Sie die API Endpunkte zu, für welche der neue Key Zugang erhalten soll.