Hoe werken API-sleutels en webhooks in priceq?

Beide staan in Instellingen en beide zijn bedoeld voor een ontwikkelaar. Met een API-sleutel haalt je eigen systeem je producten, koppelingen en prijzen op, en levert het je catalogus aan. Een webhook werkt andersom: priceq roept een adres van jou aan als er iets gebeurt. De volledige technische documentatie staat op /developers.

API-sleutels

Alleen een beheerder ziet het onderdeel API-sleutels. Zo maak je een sleutel:

1. Typ in het naamveld waarvoor de sleutel is.
2. Klik op Sleutel maken.
3. Kopieer de sleutel meteen. Het vak zegt Kopieer deze sleutel nu, omdat we hem niet nog eens kunnen tonen: priceq bewaart alleen een onleesbaar gemaakte versie.

Een sleutel geeft toegang tot gegevens, niet tot beheer. Je kunt er je abonnement niet mee opzeggen, de volledige data-export niet mee starten en geen nieuwe sleutels mee maken. Je organisatie kan tot 10 actieve sleutels tegelijk hebben.

Elke sleutel staat in de lijst met de eerste tekens, de datum waarop hij is gemaakt en het moment waarop hij voor het laatst is gebruikt. Klik op Intrekken om een sleutel uit te zetten. Vanaf dat moment wordt elke aanroep met die sleutel geweigerd en verdwijnt de sleutel uit de lijst. Een kwijtgeraakte sleutel is niet terug te halen: trek hem in en maak een nieuwe.

Webhooks

Iedereen ziet het onderdeel Webhooks. Een webhook toevoegen, pauzeren of verwijderen kan alleen met de rol Teamleider of Beheerder. Zie Rollen en wat ze mogen.

Klik op Webhook toevoegen, vul de Endpoint-URL in en kies minstens één gebeurtenis bij Stuur bij. Het adres moet beginnen met https:// en bereikbaar zijn vanaf internet. Klik daarna op Aanmaken.

Je kunt een webhook laten afgaan bij deze gebeurtenissen:

• Alert geactiveerd
• Product toegevoegd
• Product gearchiveerd
• Adviesprijs gewijzigd
• Scan voltooid
• Catalogus-synchronisatie afgerond

Na het aanmaken toont priceq één keer het signing secret van de webhook. Kopieer het direct. Je systeem controleert daarmee of een aanroep echt van priceq komt; op /developers staat hoe.

Als een levering mislukt

Elke regel eindigt in een menu met Pauzeren, Hervatten, Verwijderen en het bezorglog. Elke levering staat daar als in de wachtrij, geslaagd of opgegeven.

Ligt je server plat, reageert hij te traag of geeft hij een serverfout, dan probeert priceq het opnieuw. Dat gebeurt vijf keer in totaal, verspreid over ongeveer twintig minuten. Antwoordt je server met een clientfout zoals 404, dan stopt priceq meteen, want opnieuw proberen geeft hetzelfde antwoord.

Welke alerts een webhook kunnen laten afgaan, lees je in Wanneer gaat welke melding af?