Eerste stappen

Sie sind neu in der GASTROFIX API und möchten lernen, wie Sie schnell auf die richtige Spur kommen. Lesen Sie einfach die folgenden Abschnitte einer nach dem anderen und Sie werden in weniger als 15 Minuten einsatzbereit sein.

  • Kontoführung
    Erfahren Sie, wie Sie sich anmelden und Zugang zur GASTROFIX API erhalten.
  • Verwaltung von API-Abonnements und Berechtigungsnachweisen
    Erfahren Sie, wie die Authentifizierung für die GASTROFIX API funktioniert.
  • Aufruf der API
    Erfahren Sie, wie Sie die GASTROFIX API mit der integrierten API-Konsole ausprobieren können.

Mit diesem Grundwissen sollten Sie bereit sein für die Praxisbeispiele. Weiter zu den Tutorials.

Account

Zelf registratie

Om een account aan te maken gebruikt u de link  “Aanmelden”.

Activatieproces

Om de gegevens van een restaurant te kunnen gebruiken dient u hiervoor rechten te hebben. Vraag aan uw GASTROFIX partner om deze toegang te activeren. Na de vrijgave heeft u toegang tot alle API’s en restaurantketens waarvoor u toegang heeft gekregen.

Beheren van API-abonnemnten en rechten

API-Abonnement

Nach der Kontofreigabe werden Sie feststellen, dass mehrere Gastrofix-APIs unter dem API-Menü sichtbar sind. Die Liste der verfügbaren APIs hängt von den Berechtigungen Ihres Kontos ab. Sie können auf die API klicken, um die API-Seite zu öffnen, auf der Sie Abonnementoptionen auswählen und auf die Schaltfläche Abonnieren klicken können. Sie haben die API erfolgreich abonniert. Sie können die Liste der aktiven Abonnements auf der Seite Meine Abonnements einsehen.

Vergewissern Sie sich vor dem Aufruf, dass Sie über Zugangsdaten (Token) verfügen, wie im nächsten Abschnitt beschrieben.

Verwaltung von API-Anmeldeinformationen

Die Gastrofix API authentifiziert Client-Anwendungen basierend auf dem Access-Token. Abhängig von der Rolle Ihres Kontos sind Sie berechtigt, auf die Daten einer bestimmten Restaurantkette oder mehrerer Restaurantketten zuzugreifen. Weitere Informationen zur Anmeldung und Verwaltung Ihres Kontos finden Sie im Abschnitt Accountverwaltung.

Um das Zugriffstoken zu generieren, gehen Sie auf die Seite Meine Abonnements und klicken Sie auf die Schaltfläche Schlüssel generieren. Sie können den Gültigkeitszeitraum des Tokens festlegen (standardmäßig 24h).

Wann immer Sie einen Aufruf an unsere API machen, müssen Sie das Zugriffstoken in die Header Ihrer Anfrage einfügen. Die API validiert das Zugriffstoken und prüft, ob Sie Zugriff auf die angeforderte API-Ressource haben. Wenn die Authentifizierungs- und Autorisierungsprüfung erfolgreich bestanden wurde, leitet die API die Anfrage an unser Backend-System weiter.

API-Umgebungen

Gastrofix betreibt zwei Umgebungen. Eine davon ist die Sandbox-Umgebung, mit der Sie Ihre Integration entwickeln und testen können. Das zweite System ist die Produktionsumgebung. Wenn eine Anfrage an die API kommt, prüft sie, ob das anfordernde Token vom Typ Produktion oder Sandbox ist und leitet die Anfrage an das entsprechende Backend weiter.

Oproepen van de API

API-Documentatie

In de API-Console vindt u eenoverzicht van de API-methodes met alle endpoints, parameters en korte omschrijvingen. Om de API documentatie in Swagger (OpenAPI) formaat te downloaden klikt u op de Swagger-link in de API-console.

Test de API vanuit de console

Bevor Sie mit der Verwendung von API beginnen können, stellen Sie sicher, dass Sie API-Anmeldeinformationen generiert haben, wie unter API-Abonnements und Verwaltung von Anmeldeinformationen beschrieben.

Rufen wir die API über die integrierte Swagger-basierte API-Konsole auf. Klicken Sie auf die API und öffnen Sie die Registerkarte API-Konsole. Wählen Sie Sandbox oder Produktionsumgebung und stellen Sie sicher, dass der Berechtigungskopf gesetzt ist. Nun können Sie jede beliebige API-Methode erweitern, die erforderlichen Parameter angeben und auf die Schaltfläche Try it Out klicken. Nachdem der API-Aufruf abgeschlossen ist, sehen Sie den API-Antwortkörper und die Header sowie die Curl-Anforderungssyntax, um es von der Kommandozeile aus zu versuchen.

Ervaar meer over GASTROFIX.