Lees de authenticatiesectie opnieuw
Authenticatie bepaalt hoe elk verzoek begint. Zoek het token-endpoint, de vereiste grant, de scopes en het gedrag bij verlopen. Schrijf een klein verzoek dat alleen een token opvraagt. Als dat verzoek mislukt, kan de rest van de documentatie je nog niet helpen.
Lees hoe de API het token verwacht. Een headernaam, een voorvoegsel of een ondertekend verzoek kan anders zijn dan je verwacht. Controleer of er een refresh token is en wat er gebeurt als een vernieuwing tijdens een lange taak mislukt.
Teken het objectmodel
Teken de belangrijkste objecten en de verbindingen ertussen. Zoek de kandidaat, de sollicitatie, de vacature, het interview, de opname en de review. Noteer welk id ze verbindt en welk id stabiel is tussen systemen.
Een stabiel extern id is het anker van de koppeling. Als de documentatie alleen een intern id biedt, vraag dan of een externe verwijzing kan worden opgeslagen. Zonder dat anker kan een volgende sync een extra record maken.
Controleer paginering, filters en limieten
Zoek de vorm van paginering: een paginanummer, een cursor of een linkheader. Lees wat er op de laatste pagina gebeurt en hoe je de volgende set opvraagt. Kijk daarna naar de filters. Een lijst-endpoint dat niet op vacature of wijzigingstijd kan filteren, dwingt je koppeling om extra data te lezen.
Noteer de limieten en het aanbevolen herhaalgedrag. Als de documentatie geen productiewaarde noemt, vraag het dan aan support. Behandel een ontbrekende limiet als onbekend, niet als onbeperkt.
Volg één voorbeeld van begin tot eind
Pak één voorbeeldverzoek en volg het hele pad: verzoek, antwoord, opgeslagen id, vervolgaanroep. Vergelijk de veldnamen in het voorbeeld met de veldtabel. Voorbeelden kunnen een vereenvoudigde payload tonen, en een verplicht veld uit de tabel kan in het voorbeeld ontbreken.
Test het voorbeeld in de sandbox precies zoals het er staat. Verander daarna één veld en kijk welke fout terugkomt. Zo leer je hoe de API een validatieprobleem meldt, wat lastig te leren is uit een succesvoorbeeld.
Lees de webhook- en gebeurtenissecties
Controleer welke gebeurtenissen bestaan, wat de payload bevat en hoe de handtekening werkt. Zoek het herhaalbeleid en de replayprocedure. Een webhook zonder replaypad laat een gat wanneer je dienst niet beschikbaar is.
Kijk of de volgorde gegarandeerd is. Als gebeurtenissen in een andere volgorde kunnen aankomen, heeft je koppeling een tijd- of versieveld nodig om te bepalen welke status wint. Schrijf die regel op voordat je de eerste gebeurtenis verwerkt.
Maak van hiaten een testplan
Houd een lijst met vragen bij terwijl je leest. Elke onduidelijke zin wordt een test of een vraag aan support. Groepeer de vragen per workflow: uitnodigen, opnemen, beoordelen, beslissen en verwijderen. Stel ze in één bericht met de exacte sectie die je hebt gelezen.
Bouw een klein testplan met een geval voor succes en een geval voor een fout bij elke stap. Voeg een verlopen token, een dubbele gebeurtenis en een geweigerd veld toe. Voer het plan uit in de sandbox en noteer het resultaat naast de versie van de documentatie.
De documentatie is een kaart, niet het gebied zelf. Als de kaart onduidelijk is, laat het testplan zien waar de koppeling een beslissing nodig heeft. Die gewoonte houdt een eigen build bij concrete beslissingen in plaats van een reeks gissingen.