Je API
Alles wat je in je organisatie kunt doen, kan ook via haar API, met je eigen toegang. De API-referentie beschrijft ze.
Elke organisatie heeft haar eigen API: dezelfde acties die je in het dashboard uitvoert, beschikbaar voor andere software. De API-referentie beschrijft ze, bewerking per bewerking. Je opent ze via Technisch → API-referentie in de zijbalk.
Alleen leden van de organisatie kunnen haar API-referentie openen, en elk lid kan dat.
Wat de reference toont
Section titled “Wat de reference toont”- Hoe je ze aanroept: het adres waaronder elke bewerking valt, en hoe een verzoek zegt wie het doet.
- Groepen: records, het datamodel, publiceren, datarollen, afdelingen, leden, de organisatie en het gebeurtenislog, elk met het aantal bewerkingen erin.
- De records van elke entiteit: een groep per entiteit, met haar eigen velden, zoals de stage waarnaar je kijkt ze heeft. Schakel rechtsboven tussen Preview en Live om de andere te zien.
- Zoeken: vindt bewerkingen op wat ze doen, over alle groepen heen.
- Foutcodes: elke fout heeft dezelfde vorm, met een code waarop een programma kan reageren. Deze pagina somt ze op, met wat elke code betekent.
- Het OpenAPI-document downloaden: de volledige beschrijving als bestand, voor tools die het OpenAPI-formaat lezen.
Eén bewerking
Section titled “Eén bewerking”Kies een bewerking om ze te openen. Je ziet het volledige adres om aan te roepen, haar parameters, wat je stuurt en wat je terugkrijgt, veld per veld, en wie ze mag aanroepen.
Elke bewerking zegt ook hoeveel ze kan doen:
| Label | Betekent |
|---|---|
| Lezen | Kijkt alleen. |
| Wijzigen | Wijzigt iets wat je kunt terugdraaien. |
| Wijzigt Live | Wijzigt je echte records in Live. |
| Kan niet ongedaan worden gemaakt | Verwijdert of schrapt iets. |
| Verlaat kvyk.ai | Stuurt iets naar buiten, zoals een uitnodiging per e-mail. |
In welke taal
Section titled “In welke taal”De beschrijvingen in de referentie, de namen van de API en de foutcodes zijn in het Engels, in welke taal het dashboard ook staat: ze zijn geschreven voor ontwikkelaars. Wat de API terugzegt, zoals waarom hij iets weigerde, is in jouw taal: die waarin je account het dashboard leest, of anders die waarom een verzoek vraagt met Accept-Language.
In jouw naam, met jouw toegang
Section titled “In jouw naam, met jouw toegang”Een bewerking doet precies wat jij in het dashboard zou kunnen, niet meer: dezelfde datarollen, toegang per veld en controles gelden. Alles wat via de API gebeurt, verschijnt zoals al het andere in het gebeurtenislog.
Ook de assistent gebruikt ze
Section titled “Ook de assistent gebruikt ze”De assistent werkt via dezelfde bewerkingen. Daarom kan hij alles wat jij kunt, en daarom vraagt hij je te bevestigen voor alles wat gemarkeerd is als Wijzigt Live, Kan niet ongedaan worden gemaakt of Verlaat kvyk.ai. Hij kan de API-referentie ook voor je openen. Zie Je gegevens en de assistent.