Öffentliche API von Recipok und Zugriffstoken
Tarif Integral
Wie Sie API-Token erstellen und widerrufen, welche Daten gelesen und geschrieben werden können und wo die Dokumentation für Ihren IT-Dienstleister liegt.
Wofür es da ist
Die öffentliche API ist die Tür, durch die ein anderes Programm in Ihrem Recipok-Konto lesen und schreiben kann, ohne dass jemand Daten von Hand kopiert: Ihr Onlineshop, der Bestellungen anlegt, Ihre Warenwirtschaft, die die Lieferscheine abholt, eine Tabelle, die jeden Morgen den Bestand abfragt.
Jedes Programm meldet sich mit einem Token an, einem langen Schlüssel, den Sie erstellen, an die Person weitergeben, die die Verbindung einrichtet, und jederzeit widerrufen können. Dieser Artikel ist für den Inhaber, der diesen Schlüssel erstellen muss, und für den IT-Dienstleister, der ihn nutzen wird.
Bevor Sie beginnen
- Die Token gehören zum Tarif Integral.
- Sie werden von einem Benutzer mit der Rolle Verantwortlicher oder Administrator erstellt.
- Sie brauchen jemanden, der die Verbindung programmiert: wer Ihre Warenwirtschaft betreut, oder Ihren IT-Dienstleister. Wenn Sie niemanden haben, lesen Sie Recipok mit Rechnungsstellung, Buchhaltung oder Kasse verbinden: Wir bauen auch maßgeschneiderte Integrationen.
Wo Sie es finden
Öffnen Sie im Menü Ihres Kontos oben rechts Integrationen und dort die Registerkarte API Token. Der Bildschirm Entwickleroptionen zeigt dieselben Informationen; mit einem anderen Tarif als Integral beschreibt er nur die API und weist darauf hin, dass Ihr Tarif keine Token erzeugt.
1Basis-URL der API: https://api.recipok.com · Authentifizierungs-Header · Beispielanfrage
Vollständige API-Dokumentation anzeigen
| Name | Status | |
|---|---|---|
| Onlineshop | Sicher gespeichert | 2Entfernen |
Token-Name: Beispiele: Zapier-Integration, Lokale Entwicklung usw.
3Token generieren
- 1Die Angaben für Ihren IT-Dienstleister: die Adresse der API, der Header, in den das Token kommt, und ein Beispiel zum Kopieren.
- 2Jedes Token hat einen Namen: So wissen Sie, welches Programm es nutzt und welches Sie löschen müssen.
- 3Token generieren erstellt den Schlüssel und zeigt ihn Ihnen ein einziges Mal.
Ein Token erstellen
Geben Sie ihm einen Namen
Schreiben Sie unter Neues Token erstellen in Token-Name, wofür es ist: „Onlineshop“, „Steuerbüro“, „Tests IT“. Ein Token pro Programm.
Klicken Sie auf Token generieren
Es erscheint der Hinweis Kopieren Sie dieses Token jetzt. Klicken Sie auf Kopieren und bewahren Sie es an einem sicheren Ort auf oder schicken Sie es direkt an die Person, die die Verbindung einrichtet.
Bestätigen Sie
Wenn Sie auf Bestätigen klicken, wird das Token für immer ausgeblendet. In der Liste steht es dann als „Sicher gespeichert“: Recipok speichert es verschlüsselt und niemand kann es erneut lesen.
Token widerrufen
- Um einen Schlüssel zurückzuziehen, löschen Sie ihn unter Ihre Token mit Entfernen. Das Programm, das ihn genutzt hat, kommt sofort nicht mehr hinein.
- Der Administrator sieht außerdem Token anderer Benutzer mit ihrem Inhaber und kann bei jedem davon Token widerrufen verwenden. Nützlich, wenn jemand den Betrieb verlässt.
Ein Token gibt Zugriff auf die Daten Ihres Betriebs. Fügen Sie es nicht in E-Mails an mehrere Personen oder in gemeinsam genutzte Dokumente ein, und erstellen Sie für jedes Programm ein eigenes: So können Sie eines sperren, ohne die anderen anzuhalten.
Was ein Programm mit der API tun kann
| Bereich | Beispiele |
|---|---|
| Rezepte | Rezepte mit ihren Zutaten, Formaten, Preisen und MwSt. sowie den Nährwertangaben abfragen. |
| Zutaten und Lieferanten | Zutaten lesen und anlegen; Lieferanten abfragen. |
| Einkauf und Bestand | Wareneingänge erfassen und den Bestand abfragen oder anpassen. |
| Produktion | Produktionsaufträge anlegen, Chargen zuweisen und sie abschließen. |
| Verkauf | Verkaufsaufträge anlegen, als geliefert markieren, Warenausgänge mit ihren Chargen erfassen und Kunden abfragen oder anlegen. |
| HACCP | HACCP-Aufzeichnungen und Standorte erfassen und abfragen. |
Für Ihren IT-Dienstleister
- Die vollständige technische Dokumentation finden Sie unter api.recipok.com/api/doc (Schaltfläche Vollständige API-Dokumentation anzeigen). Sie ist in mehreren Sprachen verfügbar.
- Die API antwortet unter ihrer eigenen Domain: Anfragen an die Adresse, über die Sie sich bei Recipok anmelden, kommen dort nicht an.
- Das Token kommt bei jeder Anfrage in den Authentifizierungs-Header, den der Bildschirm angibt.
- Imperiale Einheiten, optional. Wenn die Integration mit Pfund, Unzen oder Grad Fahrenheit arbeitet, kann sie das mit dem Header X-Unit-System anfordern:
imperial_uk,us_customary,account(die in Ihrem Konto eingestellten Einheiten) odermetric. Ohne diesen Header bleibt alles wie bisher im metrischen System.
Bevor Sie ein neues Programm mit Ihrem echten Konto verbinden, lassen Sie Ihren IT-Dienstleister mit wenigen Daten testen und prüfen Sie in Recipok, was angelegt wurde. Fragen zur API klären wir im Support-Chat.