Wie funktionieren API-Schlüssel und Webhooks in priceq?

Beides findest du unter Einstellungen, und beides richtet sich an jemanden, der programmiert. Mit einem API-Schlüssel holt dein eigenes System deine Produkte, Zuordnungen und Preise ab und kann deinen Katalog auch übermitteln. Ein Webhook funktioniert andersherum: priceq ruft eine Adresse von dir auf, wenn etwas passiert. Die vollständige technische Referenz steht unter /developers.

API-Schlüssel

Nur ein Administrator sieht den Bereich API-Schlüssel. So erstellst du einen Schlüssel:

1. Gib im Namensfeld ein, wofür der Schlüssel gedacht ist.
2. Wähle Schlüssel erstellen.
3. Kopiere den Schlüssel sofort. Im Feld steht Kopiere diesen Schlüssel jetzt, denn wir können ihn nicht noch einmal zeigen: priceq speichert nur eine unlesbar gemachte Fassung davon.

Ein Schlüssel gibt Zugriff auf Daten, nicht auf die Verwaltung. Er kann weder das Abonnement kündigen noch den vollständigen Datenexport starten, und er kann keine weiteren Schlüssel anlegen. Deine Organisation kann bis zu 10 aktive Schlüssel gleichzeitig haben.

Jeder Schlüssel steht in der Liste mit seinen ersten Zeichen. Daneben siehst du, wann er erstellt und wann er zuletzt genutzt wurde. Mit Widerrufen schaltest du einen Schlüssel ab. Ab diesem Moment wird jeder Aufruf mit diesem Schlüssel abgelehnt, und der Schlüssel verschwindet aus der Liste. Ein verlorener Schlüssel lässt sich nicht wiederherstellen: Widerrufe ihn und erstelle einen neuen.

Webhooks

Den Bereich Webhooks sehen alle. Zum Hinzufügen, Pausieren oder Löschen eines Webhooks brauchst du aber die Rolle Teamleiter oder Administrator. Siehe Rollen und was sie dürfen.

Wähle Webhook hinzufügen und trag die Endpoint-URL ein. Unter Senden bei wählst du mindestens ein Ereignis. Die Adresse muss mit https:// beginnen und aus dem Internet erreichbar sein. Wähle dann Erstellen.

Diese Ereignisse stehen zur Auswahl:

• Warnung ausgelöst
• Produkt hinzugefügt
• Produkt archiviert
• UVP geändert
• Scan abgeschlossen
• Katalog-Synchronisation abgeschlossen

Nach dem Erstellen zeigt priceq einmalig das Signing-Secret des Webhooks. Kopiere es sofort. Dein System prüft damit, ob ein Aufruf wirklich von priceq kommt. Wie das geht, erklärt /developers.

Wenn eine Zustellung fehlschlägt

Jede Zeile endet mit einem Menü mit Pausieren, Fortsetzen, Löschen und dem Zustelllog. Jede Zustellung darin steht auf in der Warteschlange, erfolgreich oder aufgegeben.

Ist dein Server nicht erreichbar, zu langsam oder meldet er einen Serverfehler, versucht priceq es erneut: insgesamt fünf Versuche, verteilt über etwa zwanzig Minuten. Antwortet dein Server mit einem Client-Fehler wie 404, hört priceq sofort auf. Ein neuer Versuch brächte dieselbe Antwort.

Welche Warnungen einen Webhook auslösen können, erklärt Was löst welche Warnung aus?