De opgevraagde inhoud wordt geleverd in JSON<\/strong>-formaat met UTF-8-codering. Als een ander formaat wordt gebruikt, wordt dat in de beschrijving van de methode vermeld.<\/p>\n HTTP-statuscode geeft de status van het verzoek aan – voor succesvolle verzoeken wordt statuscode 200<\/strong>geretourneerd. Samen met dit antwoord wordt de gevraagde informatie van de server ontvangen. De antwoorden zullen verschillen afhankelijk van het type API dat wordt gebruikt. De API-antwoorden voor de verschillende API-types worden in de volgende hoofdstukken beschreven.<\/p>\n Indien er een fout is opgetreden in het verzonden verzoek, zal het systeem een antwoordbericht terugsturen met een statuscode. Veel voorkomende foutcodes:<\/p>\n Foutcodes geven enige algemene informatie over het soort fout, zodat de gebruiker de oorzaak van het probleem kan achterhalen.<\/p>\n Sommige API’s hebben optionele elementen (parameters) in hun respons, optionele parameters kunnen om verschillende redenen door het systeem worden overgeslagen (geen gegevens, slechte gegevens, respons time out, enz.) Een gebruiker mag er niet van uitgaan dat bepaalde facultatieve gegevens altijd in een antwoord zullen worden opgenomen.<\/p>\n Alle API’s hebben \u00e9\u00e9n enkele beperking:<\/p>\n Deze beperking geldt voor alle bestaande FMS API’s.<\/p>\n API-authenticatie en -autorisatie zijn nodig om het API-gebruik voor verschillende cli\u00ebnten en hun integratie met verschillende systemen te controleren. Om een geautoriseerd verzoek te doen aan systeem-API’s, moet de verzoekende toepassing van de cli\u00ebnt eerst een API-sleutel<\/strong>verkrijgen namens de webgebruiker van het systeem.<\/p>\n Cli\u00ebnten kunnen alleen een API-sleutel verkrijgen door rechtstreeks contact op te nemen met de technische ondersteuning van hun dienstverleners. API sleutel bestaat uit willekeurig gegenereerde letters, cijfers en symbolen.<\/p>\n Voorbeeld van een verzoek waarbij een API_key wordt gebruikt:<\/p>\n Indien de API_key is verlopen, verwijderd of eenvoudigweg uitgeschakeld, zal het systeem de volgende reactie terugsturen:<\/p>\n API endpoints, verzoekparameters en antwoorden kunnen via deze link in “Swagger” worden bekeken: https:\/\/api.fm-track.com<\/a><\/p>\n Notitie! Belangrijk! De API-oplossing wordt voortdurend bijgewerkt, verbeterd en anderszins gewijzigd, en daarom is het noodzakelijk te begrijpen wat “compatibiliteit” betekent en hoe dit de gebruiker be\u00efnvloedt bij het gebruik van de API-oplossing.<\/p>\n Wanneer een API wordt bijgewerkt, gebeurt een van de volgende twee mogelijkheden:<\/p>\n Wat wordt beschouwd als een achterwaarts compatibele API-versie:<\/p>\n <\/p>\n API (toepassingsprogramma-interface) laat klanten FMS integreren in hun systemen, en gegevens over verschillende entiteiten ophalen en doorsturen. De client doet HTTP-verzoeken aan het systeem, waarbij informatie wordt verstrekt over de voorgenomen actie. HTTP-commando’s die gewoonlijk in een API worden gebruikt: KRIJGEN \u2013 Lees bron; POST\u2013 Wijzig bronstatus; De opgevraagde inhoud wordt geleverd in JSON-formaat met … Lees verder APIs<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":116,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-12606","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.fmsdocumentation.com\/nl\/wp-json\/wp\/v2\/pages\/12606","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.fmsdocumentation.com\/nl\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.fmsdocumentation.com\/nl\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/nl\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.fmsdocumentation.com\/nl\/wp-json\/wp\/v2\/comments?post=12606"}],"version-history":[{"count":0,"href":"https:\/\/www.fmsdocumentation.com\/nl\/wp-json\/wp\/v2\/pages\/12606\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.fmsdocumentation.com\/nl\/wp-json\/wp\/v2\/media?parent=12606"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
\nAPI Beperkingen<\/h3>\n
\n
\nAPI-authenticatie<\/h3>\n
![\"\"](\"https:\/\/www.fmsdocumentation.com\/wp-content\/uploads\/2017\/04\/1.png\")
<\/a><\/p>\n<\/a><\/p>\n
\nBij alle soorten API’s moet altijd een API-versie worden opgegeven.<\/p><\/p>\n
\nVanwege de voortdurende ontwikkeling van zowel de API als het systeem van waaruit de informatie wordt opgevraagd, kunnen gebruikers soms parameters ontvangen die niet in de beschrijvingen zijn opgenomen. Het wordt aanbevolen om onbekende parameters die niet gedocumenteerd zijn in de beschrijving van elke API, gewoon te negeren.<\/p><\/p>\n
\nVersiebeheer en compatibiliteit<\/h3>\n
\n
\n
\nDe gebruiker kan er veilig van uitgaan dat de object ID’s die het systeem genereert nooit langer zullen zijn dan 255 tekens, maar de gebruiker moet in staat zijn ID’s met een mogelijke lengte van 255 tekens te hanteren. Bijvoorbeeld, de gebruiker gebruikt MySQL, ID’s moeten worden opgeslagen in een VARCHAR(255) COLLATE utf8_bin kolom (de COLLATE configuratie zorgt voor hoofdlettergevoeligheid bij lookups).<\/li>\n
\n