Die ChannelDock REST-API ermöglicht es Ihnen, Ihre eigene Software mit ChannelDock zu verbinden und mit Bestellungen, Produkten, Sendungen, Rücksendungen und Bestandsaktualisierungen zu arbeiten.
Die vollständige Liste der Endpunkte, Authentifizierungsdetails, Anfragebeispiele und Antwortbeispiele finden Sie in unserer Postman-Dokumentation hier:
Was können Sie mit der REST-API tun?
- Bestellungen und Bestellaktualisierungen abrufen
- Produkt- und Bestandsinformationen lesen
- Sendungen erstellen oder aktualisieren, abhängig vom Endpunkt
- Eigene Integrationen zwischen ChannelDock und Ihrem ERP, WMS oder Webshop erstellen
Erste Schritte
1. Melden Sie sich bei ChannelDock an und gehen Sie zu Einstellungen -> API & Webhooks.
2. Klicken Sie im Abschnitt API-Schlüssel auf Neue API-Schlüssel generieren.
3. Geben Sie den Zugangsdaten eine aussagekräftige Beschreibung, damit Sie die Integration später wiedererkennen können.
4. Speichern Sie den API-Schlüssel und das API-Geheimnis an einem sicheren Ort.
5. Öffnen Sie die Postman-Dokumentation, um die verfügbaren Endpunkte, erforderlichen Parameter und Beispiel-Payloads zu prüfen, bevor Sie mit der Entwicklung beginnen.
Authentifizierung und Sicherheit
Jede API-Anfrage muss mit Ihren API-Zugangsdaten authentifiziert werden. Halten Sie Ihren API-Schlüssel und Ihr API-Geheimnis privat und geben Sie diese niemals in Frontend-Code oder öffentlichen Repositories preis.
Wir empfehlen, für jede Integration einen separaten API-Schlüssel zu erstellen und die Berechtigungen für Endpunkte zu beschränken, damit Sie den Zugriff verwalten und bei Bedarf Zugangsdaten austauschen können.
Ratenbegrenzung
Die ChannelDock REST-API wendet eine Ratenbegrenzung pro API-Schlüssel an. Standardmäßig kann ein API-Schlüssel bis zu 1000 Anfragen pro Stunde ausführen.
Jede API-Antwort enthält die folgenden Rate-Limit-Header:
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Reset
Wenn das Limit überschritten wird, gibt die API eine HTTP-429-Antwort mit der Meldung zurück:
API-Aufruflimit überschritten. Bitte versuchen Sie es später erneut.
Wir empfehlen, die Header X-RateLimit-Remaining und X-RateLimit-Reset in Ihrer Integration zu überwachen, damit Sie die Anfragen verlangsamen können, bevor Sie das Limit erreichen.
Beste Vorgehensweisen
- Testen Sie Ihre Anfragen zunächst in Postman, bevor Sie sie in die Produktion überführen.
- Beschränken Sie die Endpunktberechtigungen auf die Methoden, die Ihre Integration benötigt.
- Verwenden Sie Webhooks, wenn Sie nahezu Echtzeit-Updates benötigen, anstatt die API kontinuierlich abzufragen.
Dieser Artikel wurde automatisch aus dem Englischen übersetzt.