Wat betekent API?

Een API-afkorting voor Application Programming Interface betekent een reeks functiecodes waarmee applicaties toegang krijgen tot gespecificeerde gegevens en kunnen communiceren met externe softwareapplicatiecomponenten, besturingssystemen of microservices.

Ter vereenvoudiging levert een API een gebruikersreactie aan een systeem en stuurt de reactie van het systeem terug naar een gebruiker. U klikt op “toevoegen aan winkelwagen;” een API vertelt de site dat u een product aan uw winkelwagentje heeft toegevoegd; de website plaatst het product in uw winkelwagen en uw winkelwagen wordt bijgewerkt.

Mogelijk hoor je de term ‘microservices’ verschijnen in relatie tot API. Deze zijn echter niet hetzelfde. Microservices zijn een stijl of architectuur die functionaliteit binnen een webapplicatie verdeelt. Terwijl API het raamwerk is waarmee ontwikkelaars communiceren met een webapplicatie. Microservices kunnen dat wel gebruik API om te communiceren tussen elkaar.

Met API kan een ontwikkelaar een specifiek ‘oproep’ of ‘verzoek’ doen om informatie te verzenden of te ontvangen. Deze communicatie gebeurt met behulp van een programmeertaal genaamd “JSON.” Het kan ook worden gebruikt om een ​​gedefinieerde actie uit te voeren, zoals het bijwerken of verwijderen van gegevens. Er zijn vier basisverzoekmethoden die met de API kunnen worden ingediend:

GET – Verzamelt informatie (alle couponcodes ophalen)

PUT – Update gegevens (productprijzen bijwerken)

POST – Creëert (een nieuwe productcategorie maken)

DELETE – (Een blogpost verwijderen)

Wat is JSON en waarom wordt het gebruikt?

JSON (JavaScript Object Notation) wordt gebruikt om gegevens op een server weer te geven. Het is vrij gemakkelijk te lezen door mensen, en gemakkelijk te begrijpen door machines/applicaties. Laten we een voorbeeld van JSON bekijken van een product op BigCommerce:

Dit is gemakkelijk te begrijpen omdat het wordt uitgevoerd in sleutel/waarde-paren, met de sleutel aan de linkerkant en een waarde aan de rechterkant. Sleutels zijn een vast object dat door de applicatie wordt gedefinieerd en blijven hetzelfde als bij ‘categorie’. Terwijl de waarden uniek zullen zijn, zoals 'Overhemden'.

Wat is een API-verzoek?

Er zijn verschillende componenten van een API-verzoek om te kunnen functioneren. Laten we deze afzonderlijk bekijken en bekijken hoe ze kunnen worden gebruikt om een ​​verzoek samen te stellen.

Wat is Eindpunt?

Er zijn twee belangrijke onderdelen van een eindpunt die worden gebruikt bij het doen van een API-verzoek. Eén daarvan is de URL. BigCommerce gebruikt https://api.bigcommerce.com/stores/ als URL voor alle API-verzoeken. Dit ziet er misschien uit als een gewone URL, maar als u deze in een webbrowser aansluit, ontvangt u een 404-foutmelding.

Het tweede deel is het pad. Het pad zal variëren, afhankelijk van wat u probeert te bereiken. U kunt een lijst met beschikbare paden voor BigCommerce vinden door onze ontwikkelaarsdocumentatie te bezoeken: https://developer.bigcommerce.com/api-reference. Voor dit voorbeeld gaan we het productpad gebruiken: /v3/catalog/products.

Wanneer we deze twee delen samenvoegen, krijgen we een compleet eindpunt https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Nu zeg je misschien tegen jezelf: 'Wat is de {store_hash}?' 'Waar komt dat vandaan?' Dit is wat bekend staat als een variabele. Variabelen zijn unieke componenten voor een eindpunt en variëren afhankelijk van de informatie van uw winkel. U kunt een variabele herkennen aan de open en gesloten haakjes “{ }”.

Wat is koptekst?

Headers geven informatie aan de client en server. Veelvoorkomende voorbeelden van een header zijn authenticatiereferenties zoals een “Auth Token” of “Client ID”. Deze inloggegevens worden automatisch aan u verstrekt wanneer u een API-account aanmaakt. Een andere veel voorkomende header wordt het ‘Contenttype’ genoemd, dat de server informeert over welk type inhoud zal worden verzonden. Een veelgebruikt inhoudstype is bijvoorbeeld 'application/json', waardoor de server weet dat we JSON-gegevens verzenden.

Wat is methode?

Methoden zijn de acties die worden ondernomen bij het verzenden van een verzoek. Denk eens terug aan het begin toen we GET, PUT, POST en DELETE bespraken. Dit zijn allemaal API-methoden.

Wat zijn gegevens?

De verzoekgegevens, ook wel de ‘body’ genoemd, zijn informatie die naar een server wordt verzonden of door deze wordt geretourneerd. In de vorige bespreking van JSON ziet u een voorbeeld van API-gegevens. De hoofdtekst van een verzoek vereist soms specifieke informatie voordat het kan worden afgeleverd. Een voorbeeld hiervan is dat als u één product bewerkt, de product-ID vereist is voordat er wijzigingen kunnen worden aangebracht.

Lees meer hier.