API
Når din egen kode skal lese data eller utføre en dokumentert handling i Alunta.
Finn endepunktet dittAlunta for utviklere
Bygg produktet ditt. La Alunta ta seg av abonnementene. Koble kundedata og faste avtaler til via API-et.
REST API · JSON · OpenAPI
Kunder skal slippe å bli opprettet to ganger, og teamet skal ikke flytte tall for hånd. Koble sammen arbeidsflytene du allerede bruker, og la Alunta håndtere abonnementene i bakgrunnen.
Vis kundeabonnementer i ditt eget system slik at salg og support har avtalen for hånden. API-et gir deg kundedata og referanser for å koble dem til resten av virksomheten.
GET /customersLa kundene velge i appen din og kjøpe gjennom Aluntas checkout. En checkout-økt og hendelsen etter kjøpet kobler opplevelsen til produktet ditt.
POST /checkout-sessionsSelger du etter bruk? Send målingene fra appen til Alunta og ta dem med i abonnementets bruksbaserte fakturering. Du bygger produktet; Alunta kobler målingene til avtalen.
POST /subscriptions/{uuid}/usageFra idé til kobling
Du trenger ikke bygge hele integrasjonen på én gang. Hent kundene, se på svaret og fortsett derfra. Dokumentasjonen og et første eksempel ligger klart.
Aktiver API-tilgang i Alunta og bruk et tilgangstoken for kontoen integrasjonen skal arbeide med. Tilgangen følger tokenets tillatelser og den tilknyttede kontoen.
Lagre tokenet sikkert på serveren som ALUNTA_TOKEN og kjør eksemplet. Kallet leser kundeinformasjon uten å endre data.
Bruk kundenes UUID-er til å koble sammen resten av arbeidsflyten. Referansen hjelper deg med å finne feltene og kallene integrasjonen trenger.
Eksemplet bruker den dokumenterte v1-adressen og bearer-autentisering. Du trenger et gyldig token med kundetilgang på Alunta-kontoen din.
Les kom i gang-guidencurl --request GET \
'https://app.alunta.com/api/v1/customers' \
--header "Authorization: Bearer $ALUNTA_TOKEN" \
--header 'Accept: application/json'ALUNTA_TOKEN er en miljøvariabel i ditt eget miljø. Oppbevar tokenet på serveren og utenfor kildekode, nettleserkode og logger.
Når dataene dine endrer seg
Et abonnement endres. En betaling registreres. Produktet ditt kan få beskjed og fortsette mens teamet bruker tiden på kundene. Det er det webhooks er til for.
Velg relevante hendelser og ta imot dem på HTTPS-endepunktet ditt. Dokumentasjonen har detaljer om signaturer, levering og nye forsøk.
Kontroller signaturen mot den rå request-body-en slik dokumentasjonen beskriver, før du behandler hendelsen.
Ta imot leveringen og legg oppfølgingsarbeidet i din egen kø. Dokumentasjonen oppgir gjeldende tidsgrense for svar.
En hendelse kan leveres flere ganger. Sørg for at en gjentatt levering ikke utløser samme handling på nytt.
Bygger du med en kodeassistent? Gi den OpenAPI-filen og dokumentasjonen fra Alunta, slik at den bruker riktige endepunkter og svar. Da får du et konkret utgangspunkt for integrasjonen og mer tid til din egen kode.
Et API-svar viser neste steg. Her er tre vanlige meldinger og hva du kan gjøre.
401 / 403Kontroller tilgang422Kontroller innholdet429La kallet få tidStår du fast? Send oss X-Request-Id, så kan vi finne kallet. Skrivekall og mislykkede kall vises under Innstillinger → API → Logg. Ikke del tokenet ditt.
Når din egen kode skal lese data eller utføre en dokumentert handling i Alunta.
Finn endepunktet dittNår en kompatibel KI-assistent skal bruke utvalgt informasjon og verktøy fra kontoen din.
Se KI-tilgangNår en eksisterende kobling eller arbeidsflyt kan gjøre jobben for deg.
Finn en integrasjonEt token gir tilgang til den tilknyttede kontoen og handlingene tillatelsene åpner for. Planlegg kontokoblingen i integrasjonen din. Bruk /me for å se konteksten til den autentiserte kontoen.
Oppbevar tokenet på serveren. La serveren kalle Alunta og send bare informasjonen grensesnittet trenger. Ikke legg API-tokenet i offentlig nettleserkode.
Fortell oss om arbeidsflyten og informasjonen eller handlingen du trenger. Vi undersøker det gjerne sammen med deg. Den offentlige referansen viser hva du kan bygge i dag.
Ja. Send en beskrivelse av hva du vil koble til, endepunktet og eventuell HTTP-status eller X-Request-Id til support@alunta.com. Ikke ta med tokens eller sensitive kundedata.
Har du en idé, en frustrerende manuell oppgave eller en integrasjon du vil bygge? Snakk med oss. Vi hjelper gjerne med å finne en god kobling mellom produktet ditt og Alunta.
La oss bygge koblingen sammenBruk det dokumenterte API-et til støttede kunde- og abonnementshandlinger. Beskytt tilgangsopplysningene.
La webhooks varsle programvaren om støttede hendelser. Planlegg nye forsøk og kontroller innkommende forespørsler.
Test hele forløpet før oppstart. Dokumentasjonen beskriver tilgjengelige handlinger og begrensninger.