Naar de inhoud

API-integratiespecificatie

Leg vast hoe twee systemen worden gekoppeld: welke gegevens worden uitgewisseld, hoe dit beveiligd is, hoe fouten worden afgehandeld en wie eigenaar is.

Invullen en voorbeeld bekijken

API-integratiespecificatie

Integratie: Webshoporders naar boekhouding
Versie: 1.0
Opgesteld door: Hamza Idrissi
Datum: 5 april 2029

1. Doel

Stuur elke betaalde webshoporder als verkoopfactuur naar het boekhoudsysteem, zodat de financiële afdeling die niet opnieuw hoeft in te voeren.

2. Systemen

  • Verstuurt gegevens: Webshop (API v2)
  • Ontvangt gegevens: Boekhoudsysteem (REST API)

3. Gegevensstroom

1. Een klant betaalt voor een order.
2. De webshop stuurt een webhook naar de integratieservice.
3. De service zet de order om in een factuur en roept de boekhoud-API aan.
4. Het boekhoudsysteem retourneert een factuurnummer, dat de service bij de order opslaat.

4. Endpoints en berichten

Methode en pad Wat het doet Belangrijkste velden Wat het teruggeeft
POST /invoices Een factuur aanmaken Body: klant, regels, belasting, totaal Retourneert: factuur-id en factuurnummer
GET /customers?email= Een klant zoeken Retourneert: klant-id of leeg
POST /customers Een klant aanmaken Body: naam, e-mail, adres

5. Veldmapping

order.total_paid → invoice.total
order.billing_email → customer.email
order.items[].sku → line.product_code

6. Authenticatie en beveiliging

OAuth 2.0 met clientcredentials. Tokens zijn één uur geldig. Secrets staan in de vault, nooit in code. Alle aanroepen gebruiken HTTPS. Webhooks zijn ondertekend en de handtekening wordt gecontroleerd.

Persoonsgegevens worden alleen verstuurd wanneer dat nodig is, worden niet naar logs geschreven en vallen onder de privacyvoorwaarden van beide systemen.

7. Fouten en nieuwe pogingen

Probeer het opnieuw bij 429 en 5xx, tot 5 keer met oplopende wachttijden. Probeer 4xx-fouten niet opnieuw; log ze en waarschuw de financiële afdeling. Elke factuur heeft een unieke sleutel, zodat een nieuwe poging geen duplicaat kan aanmaken.

8. Limieten en volumes

De boekhoud-API staat 60 aanroepen per minuut toe. Verwacht 400 orders per dag, tot 2.000 op actiedagen.

9. Testen

Gebruik de boekhoud-sandbox. Test een normale order, een order met korting, een terugbetaling, een klant die al bestaat en een storing van de API.

10. Eigenaars en ondersteuning

Eigenaar: E-commerce team. Ondersteuning: Hamza Idrissi. Escalatie: de supportdesk van de boekhoudleverancier.

11. Wijzigingen en versiebeheer

Elke partij kondigt een ingrijpende wijziging 30 dagen van tevoren aan.

Sjablonen zijn een zorgvuldig startpunt, geen juridisch advies. Controleer bij juridische kwesties altijd wat lokaal van toepassing is.

IT en projecten

Waarvoor dit sjabloon dient

Een API-integratiespecificatie beschrijft hoe twee systemen verbinden: doel, gegevensstroom, endpoints, authenticatie, fouten, limieten, tests en eigenaarschap.

Online invullen is gratis, vraagt geen account en je downloadt het als Word-document of PDF. Alle sjablonen voor IT en projecten bekijken

IT en projecten

Wat je invult

Het formulier vraagt om 16 gegevens. Het document vult zichzelf in terwijl je typt.

  • Naam integratie

    Bijvoorbeeld: Webshoporders naar boekhouding

  • Documentversie

    Bijvoorbeeld: 1.0

  • Opgesteld door

    Bijvoorbeeld: Hamza Idrissi

  • Datum

    Bijvoorbeeld: 5 april 2029

  • Doel

    Bijvoorbeeld: Stuur elke betaalde webshoporder als verkoopfactuur naar het boekhoudsysteem, zodat de financiële afdeling die niet opnieuw hoeft in te voeren.

  • Systeem dat gegevens verstuurt

    Bijvoorbeeld: Webshop (API v2)

  • Systeem dat gegevens ontvangt

    Bijvoorbeeld: Boekhoudsysteem (REST API)

  • Gegevensstroom

    Bijvoorbeeld: 1. Een klant betaalt voor een order. 2. De webshop stuurt een webhook naar de integratieservice. 3. De service zet de order om in een factuur en roept de boekhoud-API aan. 4. Het boekhoudsysteem retourneert een factuurnummer, dat de service bij de order opslaat.

  • Endpoints en berichten

    Eén rij per endpoint of bericht.

    Bijvoorbeeld: POST /invoices | Een factuur aanmaken | Body: klant, regels, belasting, totaal | Retourneert: factuur-id en factuurnummer GET /customers?email= | Een klant zoeken | Retourneert: klant-id of leeg POST /customers | Een klant aanmaken | Body: naam, e-mail, adres

  • Veldmapping

    Welk veld in de bron naar welk veld in het doel gaat. Vermeld hoe waarden worden omgezet.

    Bijvoorbeeld: order.total_paid → invoice.total order.billing_email → customer.email order.items[].sku → line.product_code

  • Authenticatie en beveiliging

    Bijvoorbeeld: OAuth 2.0 met clientcredentials. Tokens zijn één uur geldig. Secrets staan in de vault, nooit in code. Alle aanroepen gebruiken HTTPS. Webhooks zijn ondertekend en de handtekening wordt gecontroleerd.

  • Fouten en nieuwe pogingen

    Bijvoorbeeld: Probeer het opnieuw bij 429 en 5xx, tot 5 keer met oplopende wachttijden. Probeer 4xx-fouten niet opnieuw; log ze en waarschuw de financiële afdeling. Elke factuur heeft een unieke sleutel, zodat een nieuwe poging geen duplicaat kan aanmaken.

  • Limieten en volumes (optioneel)optioneel

    Bijvoorbeeld: De boekhoud-API staat 60 aanroepen per minuut toe. Verwacht 400 orders per dag, tot 2.000 op actiedagen.

  • Testen

    Bijvoorbeeld: Gebruik de boekhoud-sandbox. Test een normale order, een order met korting, een terugbetaling, een klant die al bestaat en een storing van de API.

  • Eigenaars en ondersteuning

    Bijvoorbeeld: Eigenaar: E-commerce team. Ondersteuning: Hamza Idrissi. Escalatie: de supportdesk van de boekhoudleverancier.

  • Wijzigingen en versiebeheer (optioneel)optioneel

    Bijvoorbeeld: Elke partij kondigt een ingrijpende wijziging 30 dagen van tevoren aan.

IT en projecten

Wat erin staat

De onderdelen van dit document, in volgorde.

  1. 11. Doel
  2. 22. Systemen
  3. 33. Gegevensstroom
  4. 44. Endpoints en berichten
  5. 55. Veldmapping
  6. 66. Authenticatie en beveiliging
  7. 77. Fouten en nieuwe pogingen
  8. 88. Limieten en volumes
  9. 99. Testen
  10. 1010. Eigenaars en ondersteuning
  11. 1111. Wijzigingen en versiebeheer

Sjablonen

Hoe het werkt

  1. 01

    Invullen

    Typ je gegevens in het formulier. Het document vult zich in terwijl je typt; klik op een lege plek om direct naar het bijbehorende veld te springen.

  2. 02

    Controleren

    Lees het door. Lege plekken die je niet hebt ingevuld blijven gemarkeerd, zodat er niets half af de deur uitgaat.

  3. 03

    Downloaden

    Sla het op als Word-document om verder te bewerken, of als PDF om te versturen of af te drukken.

Pas het aan met AI

Open het in de chat en vraag om aanpassingen: korter, zakelijker, voor een andere situatie of in een andere taal.

Aanpassen met nerix

IT en projecten

Vragen die mensen stellen

Welke gegevens vraagt dit sjabloon?

Het formulier vraagt om 16 gegevens, te beginnen met Naam integratie, Documentversie, Opgesteld door, Datum, Doel. 2 andere zijn optioneel.

Kan ik dit sjabloon downloaden als Word of PDF?

Ja. Als je het formulier hebt ingevuld, sla je het op als Word-document om verder te bewerken, of als PDF om te versturen of af te drukken. Het is gratis en vraagt geen account.

Wordt wat ik typ ergens naartoe gestuurd?

Nee. Wat je typt blijft in je browser terwijl je het document invult. Het gaat alleen naar nerix als je ervoor kiest het sjabloon in de chat te openen.

Zijn deze sjablonen voor IT en projecten gratis?

De meeste wel. Vul ze gratis in en download ze als Word of PDF, zonder account. Een paar langere documenten zijn premium: gratis in te vullen, eenmalig te betalen om te downloaden en met hun prijs aangegeven.

Maakt een beveiligingsbeleid ons veilig?

Geen enkel document doet dat alleen. Een beleid helpt als het past bij wat mensen echt doen: houd het kort, leg het uit aan je team en herzie het elk jaar.

Is een projectopdracht alleen voor grote projecten?

Nee. Ook een klein project heeft er baat bij, want één pagina met het doel, de grenzen en de beslisser voorkomt later de meeste discussies.