Hoe het precies werkt. Hoofdstuk voor hoofdstuk.

01 — Aan de slag

Van niets naar het punt waarop het werkt.

Dit hoofdstuk is bedoeld voor wie voor het eerst begint. U heeft geen voorkennis nodig en u hoeft vooraf niets in te richten. De meeste mensen zijn hier sneller doorheen dan zij hadden ingepland.

Wat u nodig heeft

• Een moment. Dat kiest u op Beginnen.
• Een pakket. Net aan, Net of Netjes; de verschillen staan op Wat het kost. Twijfelt u, begin dan met Net.
• Verder niets. Wat er daarnaast nodig blijkt, is er in de regel al.

Stappenplan

Goed om te weten. U kunt de stappen zo vaak doorlopen als u wilt. Het resultaat blijft gelijk.

02 — Begrippen

De woorden die wij gebruiken.

In deze documentatie komen steeds dezelfde begrippen terug. Wij gebruiken ze overal op dezelfde manier, zodat u nooit hoeft te raden wat er bedoeld wordt.

Komt u elders op de site een begrip tegen dat hier niet staat, dan wordt het daar gebruikt in de gewone betekenis van het woord.

03 — Hoe het samenhangt

Zes lagen, één richting.

Alles wat binnenkomt, doorloopt zes lagen. Elke laag doet één ding en geeft het door aan de volgende. U hoeft de lagen niet te kennen om te kunnen beginnen; het helpt wel als u wilt begrijpen waarom het werkt.

1. Invoer. Hier komt het binnen, via één ingang.
2. Regie. Hier wordt bepaald waar het heen gaat.
3. Verwerking. Hier loopt het door.
4. Borging. Hier wordt vastgesteld dat het goed is gegaan.
5. Uitvoer. Hier komt het eruit.
6. Uitkomst. Het werkt.

invoer → regie → verwerking → borging → uitvoer → uitkomst
  ↑                                          │
  └──────────────────────────────────────────┘

Wat er bij de uitvoer uitkomt, kan bij de invoer weer naar binnen. Daardoor hoeft u tussentijds niets te doen. Het volledige schema, met alle knooppunten en routes, vindt u op Hoe het werkt.

04 — Koppelingen

Het werkt samen met wat u al heeft.

Het is ontworpen om naast het bestaande te werken, niet in plaats daarvan. Er zijn drie manieren om te koppelen. Welke u kiest, hangt af van wat u al gebruikt.

In alle drie de gevallen werkt het. Staat wat u gebruikt niet in het overzicht, dan betekent dat niet dat het niet samenwerkt; het overzicht wordt doorlopend aangevuld.

Bekijk alle integraties

05 — Toegang

Een sleutel is niet nodig.

Voor het eindpunt heeft u geen sleutel nodig. Schrijft uw organisatie voor dat elk verzoek van een sleutel is voorzien, dan kunt u er een meesturen. De sleutel wordt in ontvangst genomen en heeft geen invloed op het antwoord.

Authorization: Bearer UW_SLEUTEL

Uw sleutel vindt u na het inloggen. Bent u uw wachtwoord kwijt, dan kunt u het opnieuw instellen. Wat wij bij een verzoek vastleggen, leest u in Wat het van u weet.

06 — Naslag

Eén eindpunt. Eén antwoord.

De naslag beschrijft het volledige koppelvlak. Dat bestaat uit één eindpunt, waarmee u op elk moment kunt opvragen of het werkt.

Parameters

Alle parameters zijn optioneel. U kunt ze in elke volgorde en in elke combinatie meesturen.

Voorbeeldverzoek

curl "https://hetwerkt.net/v1/werkt?waar=hier&net=true"

Voorbeeldantwoord

HTTP/1.1 200 OK
Content-Length: 15

{"werkt": true}

Velden in het antwoord

Statuscodes

Andere statuscodes zijn niet voorzien. Er is geen limiet op het aantal verzoeken. Het antwoord wordt niet bewaard tussen twee verzoeken; het is elke keer opnieuw waar.

Probeer het

Hieronder kunt u een verzoek samenstellen en versturen. Vul de parameters in die u wilt meegeven, of laat ze leeg.

07 — Vragen en hulp

Komt u er niet uit.

De meeste vragen zijn al eens gesteld. Begin daarom bij de veelgestelde vragen; daarna wijzen de andere pagina's vanzelf de weg.