Support
Wat is een API? Een API (Application Programming Interface) is een manier waarop verschillende softwaresystemen veilig en gestructureerd met elkaar communiceren. In dit geval zorgt de API ervoor dat onze systemen gegevens kunnen uitwisselen met die van jou. Door verbinding te maken met onze API’s kunt u onze oplossingen direct integreren in uw eigen producten, applicaties of werkprocessen.
Hoe kan ik verbinding maken met een API? Er zijn verschillende gebruiksvriendelijke tools beschikbaar om eenvoudig verbinding te maken met een API. Een veelgebruikt voorbeeld hiervan is Postman.
Waarom heb ik een API-sleutel nodig en waar vind ik die? Een API-sleutel is nodig om toegang te krijgen tot een bepaalde API of groep API’s. Met de sleutel en het account van de gebruiker weten wij wie een verzoek doet en kunnen we het gebruik bijhouden voor facturatie. U kunt uw API-sleutel vinden in uw accountinformatie op het Matrixian Portal. Bewaar deze sleutel altijd veilig en deel hem niet met derden of via onbetrouwbare kanalen.
Wat is een request en hoe maak ik er een? Een request (verzoek) is een combinatie van invoerwaarden die naar een API worden verstuurt. Denk bijvoorbeeld aan een adres als u informatie wilt opvragen over een bepaald object. In onze technische documentatie staat per API welke velden verplicht zijn en welke optioneel. Met een tool zoals Postman kunt u vervolgens eenvoudig een request versturen.
Wat is een response en hoe ontvang ik die? Na het versturen van een request wordt dit door ons systeem verwerkt en ontvangt u een response (antwoord). Als het verzoek correct en compleet is, krijgt u de gegevens terug in het formaat zoals beschreven in de documentatie. Als er iets ontbreekt of fout gaat (bijvoorbeeld een ongeldig adres), ontvangt u een foutmelding met een errorcode. De betekenis van deze codes zijn te vinden in de documentatie onder API foutmeldingen.
Betaal ik ook voor foutieve of onvolledige requests? Nee, voor verzoeken die een foutmelding opleveren worden geen kosten in rekening gebracht. Alleen succesvolle requests worden gefactureerd.
Hoe stap ik over van de oude API’s (api.matrixiangroup.com) naar de nieuwe versie (api.matrixian.com/v1)? Bij de overstap naar de nieuwe API’s zijn er een aantal belangrijke wijzigingen:
URL-wijziging: vervang api.matrixiangroup.com door api.matrixian.com/v1 in uw requests.
Authenticatie: we gebruiken nu token-based authenticatie in plaats van Basic Authentication. Zorg dat u de vereiste sleutels en tokens veilig opslaat. Zie API Authenticatie voor meer details.
Endpoints: sommige endpoints zijn aangepast voor meer efficiëntie en consistentie. Bekijk de documentatie per endpoint voor details.
Response-formaat: alle responses bevatten nu een data-object (bij succes) en een error-object (bij fouten). Test uw applicatie om zeker te zijn dat alles goed werkt.
Versiebeheer: ondersteuning voor de oude API-versies stopt na een overgangsperiode. Plan uw migratie tijdig om onderbrekingen te voorkomen.
Meer informatie vindt u in onze migratiehandleiding: Migratie vanaf Matrixian Platform.
Nog steeds hulp nodig?
Staat uw vraag er niet bij? Neem dan contact met ons op via: [email protected]
Last updated