Invoervoorziening specifieke teksten API
De API specificatie is beschikbaar in het Open API Specification (OAS) versie 3 formaat.
| Versie | API specificatie |
|---|---|
| latest | ReDoc, Swagger |
Zie de SDG invoervoorziening readme voor redoc en swagger links van vorige versies
De endpoints voor de specifieke teksten API
- de TLS configuratie voldoet op basis van de analyse van SSL labs: https://www.ssllabs.com/ssltest/analyze.html?d=pdc-acc.data.vng.nl&hideResults=on
- Ook de productie omgeving voldoet: https://www.ssllabs.com/ssltest/analyze.html?d=pdc.data.vng.nl&hideResults=on
- ook internet.nl test geeft een goede score van > 80% zie: https://internet.nl/site/pdc.data.vng.nl/1482553/#control-panel-29
De specifieke teksten API kan bijvoorbeeld met Swaggerhub uitgeprobeerd worden
De specifieke teksten API wordt geautomatiseert getest met behulp van de API Testvoorziening. De ATV is vrij te gebruiken na registratie.
De API wordt getest met postman testscripts
Hoewel de API publiekelijk toegankelijk is kunnen gebruikers met een API-token ongelimiteert gebruik maken van de API waar gebruikers zonder API-token wel gelimiteert worden (100 verzoeken per minuut).
Tokens kunnen in de beheerinterface van van de invoervoorziening worden aangemaakt door de administrators.
Na opslaan van de gegevens wordt het sleutel veld gegenereerd Deze sleutel wordt ook wel API-token genoemd. De API specificatie geeft aan hoe dit token gebruikt kan worden. Token-based authentication wordt gedaan in de header. Het veld/de key die gebruikt dient te worden is "Authorization" De Value bevat de sleutel met de prefix "Token "
| Veld / Key | Value |
|---|---|
| Authorization | Token ozfdf46lk2huqiubeq49a14te6nnzb2b3kywzhgw |