Het gebruik van oAuth bij het initieren van de een koppelen voorkomt je dat een gebruiker sleutels handmatig hoeft uit te wisselen. Hiermee wordt het instellen van de koppeling voor gebruikers simpeler.

Partners kunnen een activeringslink sturen in hun applicatie om te koppelen met SnelStart.

Om een oAuth koppeling tot stand te brengen dien je een WebhookURL met SnelStart te overleggen en van ons heb je de “AppShortName” nodig als onderdeel van de activeringslink.

 

Werking oAuth 

Activatielink

Via de volgende link van de koppeling geïnitieerd worden.

Je eigen {appShortName} heb je via SnelStart verkregen.

https://web.snelstart.nl/couplings/activate/JouwappShortName

Roep je de link aan dan zie je, na inloggen, het volgende

De volgende querystring parameters zijn mogelijk:

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.

successUrl

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

 

Door een referenceKey mee te geven kan de context bepaald worden

• 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/{JouwAppShortName}?referenceKey={JouwReferentieSleutel}&successUrl=https%3A%2F%2Fweb.snelstart.nl

Als er een referenceKey wordt meegegeven dan zie je, na het inloggen, stap 2 van het koppelen.

---

Webhook

Het opgeven van je webhook is verplicht anders kan de koppeling niet tot stand komen.

Na de succesvolle activatie door de gebuiker wordt het request doorgestuurd.

Het request dat naar de door de partner opgegeven webhook url verzonden wordt ziet er als volgt uit:

POST https://{PartnerWebhook}.url

met Json data:

{
  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.