Prenumerationsordboken

Application Programming Interface

Vad är ett API?

Ett API är ett överenskommet gränssnitt som programvara använder för att utbyta data eller be ett annat program utföra en åtgärd. API står för Application Programming Interface. Det beskriver vad ett system erbjuder och hur ett annat system kan använda det.

Framtaget med AIInnehållet uppdaterat

En förfrågan har en adress och ett syfte

Med ett HTTP-API skickar din kod en förfrågan till en viss adress som kallas endpoint. Metoden anger typen av åtgärd. GET hämtar information. POST skapar ofta något eller startar en operation. Dokumentationen för varje endpoint beskriver det exakta beteendet.

Svaret innehåller en statuskod och kan ha strukturerade data, till exempel JSON. Din kod använder svaret för att fortsätta. En bra integration har också en plan för om en förfrågan behöver skickas igen eller kräver uppmärksamhet.

Ett konkret exempel

Hämta kunder från Alunta

En dokumenterad läsförfrågan som visas utan åtkomsttoken som förklaring.

GET https://app.alunta.com/api/v1/customers

Metod
GET – hämta information
Resurs
/customers – kunder
Autentisering
Bearer-token
Vid en lyckad förfrågan
Kunddata som JSON

Förfrågan ändrar inga data. Läs referensen om svarsstruktur, sidindelning och åtkomstkrav innan du bygger vidare.

Dokumentation och åtkomst hör ihop

Aluntas API-referens beskriver resurser som kunder, abonnemang och fakturor. OpenAPI-filen beskriver gränssnittet i ett format som utvecklarverktyg också kan läsa: adresser, fält, svar och krav på autentisering.

Exemplet kräver en giltig bearer-token med nödvändig åtkomst till ditt Alunta-konto. Förvara token säkert på din server, utanför offentlig webbläsarkod. Dokumentationen och tokenbehörigheterna avgör vilken information och vilka åtgärder en integration får åtkomst till. Börja med en läsförfrågan så att du förstår svaret innan du lägger till ändringar i arbetsflödet.

API:er, webhooks och MCP gör olika saker

Med ett API initierar din kod en förfrågan: ”Hämta mina kunder”. Med en webhook skickar systemet ett meddelande till din integration när en viss händelse inträffar, till exempel en betalning. Då slipper du upprepade förfrågningar enbart för att leta efter ändringar.

MCP är en standard för att ansluta AI-applikationer till externa data och verktyg. Den erbjuder ett annat sätt att ge en AI-assistent utvalda funktioner. Den gör inte automatiskt alla API-funktioner tillgängliga. Läs Aluntas sidor om API och AI-åtkomst och välj anslutning utifrån vad arbetsflödet ska göra.

Frågor och svar

Är ett API samma sak som en färdig integration?

Nej. Ett API är ett gränssnitt du kan bygga med. En färdig integration kopplar ihop system och har redan gjort val kring data, synkronisering och felhantering.

Måste jag vara utvecklare för att använda Alunta?

Nej. Du kan använda Aluntas gränssnitt och färdiga integrationer. API:t är till för arbetsflöden där din egen kod behöver koppla Alunta till en annan produkt eller process.

Källor och dokumentation