En forespørsel har en adresse og et formål
Med et HTTP-API sender koden din en forespørsel til en bestemt adresse, kalt et endepunkt. Metoden angir typen handling. GET henter informasjon. POST oppretter ofte noe eller starter en operasjon. Dokumentasjonen for hvert endepunkt beskriver den nøyaktige oppførselen.
Svaret inneholder en statuskode og kan inneholde strukturerte data, som JSON. Koden din bruker svaret for å fortsette. En god integrasjon har også en plan for når en forespørsel må gjentas eller krever oppfølging.
Et konkret eksempel
Hent kunder fra Alunta
En dokumentert leseforespørsel, vist uten tilgangstoken for å forklare prinsippet.
GET https://app.alunta.com/api/v1/customers
- Metode
- GET – hent informasjon
- Ressurs
- /customers – kunder
- Autentisering
- Bearer-token
- Ved en vellykket forespørsel
- Kundedata som JSON
Forespørselen endrer ingen data. Les referansen om svarstruktur, paginering og tilgangskrav før du bygger videre.
Dokumentasjon og tilgang hører sammen
Aluntas API-referanse beskriver ressurser som kunder, abonnementer og fakturaer. OpenAPI-filen beskriver grensesnittet i et format utviklerverktøy også kan lese: adresser, felt, svar og krav til autentisering.
Eksemplet krever et gyldig bearer-token med nødvendig tilgang til Alunta-kontoen din. Oppbevar tokenet sikkert på serveren, utenfor offentlig tilgjengelig nettleserkode. Dokumentasjonen og tokenets tillatelser avgjør hvilken informasjon og hvilke handlinger en integrasjon får tilgang til. Begynn med en leseforespørsel, slik at du forstår svaret før du legger til endringer i arbeidsflyten.
API-er, webhooks og MCP gjør ulike jobber
Med et API starter koden din en forespørsel: «Hent kundene mine». Med en webhook sender systemet en melding til integrasjonen når en bestemt hendelse skjer, for eksempel en betaling. Da slipper du gjentatte forespørsler som bare skal kontrollere om noe har endret seg.
MCP er en standard for å koble AI-applikasjoner til eksterne data og verktøy. Den gir en annen måte å tilby utvalgte funksjoner til en AI-assistent på. Den åpner ikke automatisk for alle funksjonene i et API. Se Aluntas sider om API og AI-tilgang, og velg tilkobling etter oppgaven arbeidsflyten skal løse.
Spørsmål og svar
Er et API det samme som en ferdig integrasjon?
Nei. Et API er et grensesnitt du kan bygge med. En ferdig integrasjon kobler systemer sammen og har allerede tatt valg om data, synkronisering og feilhåndtering.
Må jeg være utvikler for å bruke Alunta?
Nei. Du kan bruke Aluntas grensesnitt og ferdige integrasjoner. API-et er for arbeidsflyter der din egen kode må koble Alunta til et annet produkt eller en bestemt prosess.
