Genesis API overzicht

Het Genesis‑platform biedt een REST‑API via HTTPS. Elk verzoek wordt gedaan tegen één basis‑URL, geauthenticeerd met een token in een verzoek‑header, en levert JSON.

Basis‑URL

https://api.nxgen.cloud/api/v1

Elk pad op deze pagina’s is relatief ten opzichte hiervan: GET /user/me betekent GET https://api.nxgen.cloud/api/v1/user/me.

Authenticatie

Verzoeken dragen een token in de auth-token header. Zie Authenticatie voor hoe er één te verkrijgen.

Resources

Conventies

• Padparameters worden tussen accolades geschreven, /site/{id}. Vervang de volledige placeholder, accolades inbegrepen.
• Verzoeklichamen zijn JSON tenzij een bewerking anders aangeeft. Op deze pagina’s wordt een lichaam weergegeven als een skelet: de veldnamen met het verwachte type in plaats van elke waarde, en (required) op de velden die aanwezig moeten zijn.
• Responsetabellen vermelden elke status die de Specificatie verklaart. 401 betekent dat het token ontbrak of werd afgewezen; 403betekent dat het geldig was maar geen recht op de resource had.

Specificatie versie 1.0.0.