API-sleutel aanvragen
Sleutels geven wij met de hand uit. Er is geen selfservice-portaal: een partnerkoppeling raakt de gegevens van nabestaanden, en daar willen we een gesprek over hebben voordat er een sleutel ligt. In de praktijk is dat één mail heen en één terug.
Stuur ons een mail
Mail naar info@rouwkaart-online.nl met Partner-API in het onderwerp.
Wat we willen weten
- Name
Naam van je platform- Type
- verplicht
- Description
Zoals het bij ons in de administratie komt te staan.
- Name
Contactpersoon- Type
- verplicht
- Description
Naam en e-mailadres van degene die de koppeling bouwt en beheert. Op dit adres zoeken wij je later terug.
- Name
Testadres- Type
- verplicht
- Description
Eén e-mailadres waar in de teststand alle post naartoe gaat in plaats van naar een familie. Zonder dit adres weigert de teststand een bestelling. Liever geen bestelling dan post bij iemand die niets besteld heeft.
- Name
Webhook-adres- Type
- optioneel
- Description
Waar wij statuswijzigingen naartoe mogen sturen. Weet je dat nog niet, dan stel je het later zelf in met een mutatie.
- Name
Verwacht volume- Type
- optioneel
- Description
Een ruwe schatting van het aantal kaarten per maand. Handig voor ons om te weten; het verandert niets aan wat je krijgt.
Voorbeeldmail
Aan: info@rouwkaart-online.nl
Onderwerp: Partner-API, koppelverzoek HerdenkSamen
Hallo,
Wij willen HerdenkSamen koppelen aan Rouwkaart Online, zodat een
uitvaartondernemer vanuit ons dossier een online rouwkaart kan
laten maken.
Platform: HerdenkSamen
Contactpersoon: Marieke de Vries, beheer@herdenksamen.nl
Testadres: api-test@herdenksamen.nl
Webhook-adres: https://herdenksamen.nl/hooks/rouwkaart
Volume: naar schatting 60 kaarten per maand
Graag een test- en een livesleutel.
Met vriendelijke groet,
Marieke
Wat je terugkrijgt
Drie waarden, één keer. Zet ze meteen in een wachtwoordbeheerder.
- Name
Testsleutel- Type
- rk_test_…
- Description
Dezelfde API, maar kaarten worden als testdata gemarkeerd, post gaat naar je testadres en niets telt mee. Hiermee begin je.
- Name
Livesleutel- Type
- rk_live_…
- Description
Echte kaarten, echte bestellingen, echte post naar de familie.
- Name
Webhook-secret- Type
- 64 tekens hex
- Description
Hiermee verifieer je dat een melding echt van ons komt. Zie Webhooks.
Wij bewaren je sleutel niet, alleen zijn SHA-256. Dat betekent dat wij hem ook niet voor je kunnen opzoeken als je hem kwijtraakt. Wel kunnen we een nieuwe uitgeven; de oude werkt dan direct niet meer.
Hoe lang het duurt
Op werkdagen reageren we meestal dezelfde dag. Je krijgt de testsleutel vrijwel altijd meteen; de livesleutel volgt zodra we samen hebben vastgesteld dat de koppeling doet wat hij moet doen. Dat scheelt een eerste echte kaart die niet klopt.
Daarna
Een sleutel kwijt of uitgelekt
Mail ons op hetzelfde adres. Wij geven een nieuwe uit en trekken de oude in; dat gaat per sleutel, dus je kunt je livesleutel vervangen zonder dat je testopstelling stilvalt. Vermoed je dat er misbruik is gemaakt, zeg dat er dan bij. We kunnen de koppeling ook per direct helemaal dichtzetten terwijl we kijken wat er is gebeurd.