Een API, een afkorting voor de applicatie-programmeerinterface, is een overeengekomen manier voor software om met een ander systeem te communiceren. Een website geeft mensen knoppen en pagina's; Een API geeft software een gedefinieerde manier om informatie te vragen en het antwoord te begrijpen.
Een API is hoe een assistent de winkel een theevraag stelt en een exact antwoord krijgt in plaats van te raden vanaf een pagina.
Zie het als een serviceteller met een duidelijk bestelformulier. Het formulier zegt wat kan worden aangevraagd, en het antwoord zegt wat de winkel heeft gevonden.
Verzoeken en antwoorden
Een verzoek is de vraag die naar de service wordt gestuurd. Het kan een product-ID of voorwaarden bevatten, zoals een theetype en een prijslimiet. Het eindpunt van de service is het adres waar dat verzoek naartoe gaat. De respons, ook wel payload genoemd, is de informatie die is teruggestuurd.
Een antwoord kan een productnaam, verpakkingsgrootte, huidige prijs, voorraadstatus en een link naar de pagina bevatten. Het moet geen overeenkomend product onderscheiden van een niet-beschikbare dienst of een onbekend feit.
De twee openbare voorbeelden op teas.co.uk
De Public Guide for Software van de winkel beschrijft een Ask API voor vragen en advies, en een product-waarheids-API voor het opzoeken van een exact item. De laatste kan identifiers gebruiken zoals een barcodenummer of de eigen productcode van de winkel.
Deze routes hebben verschillende banen. Een brede vraag heeft interpretatie nodig; Een exacte productlookup heeft de juiste identiteit nodig. De Filters and Constraints Guide legt uit hoe een gedetailleerd verzoek kan worden gecontroleerd aan de hand van productkenmerken.
JSON en Markdown
Software ontvangt vaak JSON, een formaat voor benoemde waarden en lijsten. Een langer artikel kan ook beschikbaar zijn als markdown, platte tekst met eenvoudige markeringen voor koppen en links. Beide kunnen informatie gemakkelijker te hergebruiken maken. Evenmin is een afzonderlijke bron van waarheid als het wordt gegenereerd uit hetzelfde bijgehouden record.
Lezen is iets anders dan iets veranderen
Het opzoeken van een product leest informatie. Het toevoegen van een product aan een winkelmandje verandert iets. Betalen is een verdere actie. Het bestaan van een API zegt op zichzelf niets over welke van deze acties is toegestaan.
De klant blijft verantwoordelijk voor het controleren van de mand en het betalen op de site van de winkel.
citeerbare formaten
Voor journalisten, onderzoekers, AI-assistenten en contentmakers. Kies het formaat dat je nodig hebt:
- Download .md-bestand Schone Markdown-export
- .json-bestand downloaden Export van gestructureerde gegevens
vrij om te citeren, te citeren en te hergebruiken met toeschrijving aan Teas.co.uk.
Heb je iets toe te voegen? Ingelogde klanten kunnen toevoegingen aan de Tea Wiki, admin-goedgekeurd, je naam op de naamregel, plus beloningspunten indienen.
Log in om bij te dragen