De OptiSigns API is georganiseerd rond GraphQL. GraphQL is een querytaal voor API's, het biedt een complete en begrijpelijke beschrijving van de data in de API, geeft clients de mogelijkheid om exact te vragen wat ze nodig hebben en niets meer, maakt het gemakkelijker om API's in de loop van de tijd te ontwikkelen, en maakt krachtige ontwikkelaarstools mogelijk.
Waarom GraphQL
Slechts één API-eindpunt
GraphQL API's zijn georganiseerd in termen van types en velden, niet eindpunten. Krijg toegang tot de volledige mogelijkheden van uw data vanaf één enkel eindpunt. GraphQL gebruikt types om ervoor te zorgen dat apps alleen vragen wat mogelijk is en om duidelijke en nuttige foutmeldingen te geven. Apps kunnen types gebruiken om te voorkomen dat ze handmatige parseringscode moeten schrijven.
Haal veel resources op in één enkel verzoek
GraphQL queries benaderen niet alleen de eigenschappen van één resource, maar volgen ook soepel verwijzingen tussen resources. Terwijl typische REST API's het laden van meerdere URL's vereisen, halen GraphQL API's alle data die uw app nodig heeft op in één enkel verzoek. Apps die GraphQL gebruiken kunnen snel zijn, zelfs op trage mobiele netwerkverbindingen.
Geen over-fetching en under-fetching
Stuur een GraphQL query naar uw API en krijg exact wat u nodig heeft, niets meer en niets minder. GraphQL queries retourneren altijd voorspelbare resultaten. Apps die GraphQL gebruiken zijn snel en stabiel omdat zij de data die ze krijgen controleren, niet de server.
Geen versiebeheer
Nieuwe velden en types kunnen worden toegevoegd aan GraphQL API zonder bestaande queries te beïnvloeden. Verouderde velden kunnen worden afgekeurd en verborgen worden voor tools. Door één enkele evoluerende versie te gebruiken, geven GraphQL API's apps continue toegang tot nieuwe functies en stimuleren ze schonere, beter onderhoudbare servercode.
OptiSigns API eindpunt
De GraphQL API is toegankelijk via het eindpunt.
https://graphql-gateway.optisigns.com
We bieden ook een webgebaseerde GraphQL IDE om toegang te krijgen tot onze API.
https://graphql-gateway.optisigns.com/graphql
Volgend artikel - API-sleutel genereren en beheren