Activeringslink

Partners kunnen een activeringslink sturen naar hun gebruikers of deze tonen in hun applicatie.

Formaat

https://web.snelstart.nl/couplings/activate/{appShortName}

De volgende querystring parameters zijn mogelijk:

successUrl

Optioneel
Moet urlencoded zijn
Wanneer het opzetten van de koppeling voltooid is wordt de gebruiker doorgestuurd naar deze url.

referenceKey

Verplicht wanneer de app een webhook heeft.
Bevat een waarde die met de webhook mee verstuurd wordt richting de partner zodat context bepaald kan worden.

Voorbeeld

https://web.snelstart.nl/couplings/activate/snelstart?successUrl=https%3A%2F%2Fweb.snelstart.nl&referenceKey=documentatieVoorbeeld

KoppelSleutel Webhook

Partners hebben de mogelijkheid om gebruik te maken van een webhook voor de communicatie van koppelsleutels.
Hiermee wordt het instellen van de koppeling voor gebruikers simpeler, de gebruiker hoeft niet de koppelSleutel handmatig te kopieren en in te stellen in de applicatie van de partner.

Bij het aanmelden van de integratie kan een url opgegeven worden voor de webhook.
Er worden alleen https urls ondersteund.

Het request dat naar de url verzonden wordt ziet er als volgt uit:

POST https://voorbeeld.url

{
 koppelSleutel: string,
 actionType: "Create"|"Regenerate"|"Delete",
 referenceKey: string
}
Wanneer de url een statuscode van 200 t/m 299 teruggeeft wordt het request als succesvol beschouwt. Wanneer er een andere status terugkomt of de aanvraag mislukt wordt er op dit moment geen retry gedaan.