Dokumentasjon
Lær Spire på en ettermiddag
Alt du trenger for å gå fra null til produksjon. Start med «Kom i gang», les grunnlaget én gang, og slå opp produktguidene når du trenger dem. Søk med Ctrl K.
Første kall
curl https://sandkasse.spireapi.com/v1/virksomheter/923456789 \
-H "Authorization: Bearer sk_test_din_nokkel"Kom i gang
- Kom i gang · Fra konto til første vellykkede kall på under fem minutter.
- Sandkassen · Et fullt miljø for testing, gratis på alle planer.
- SDK-er · Offisielle biblioteker for Node, Python, Go, .
Grunnlag
- Autentisering · API-nøkler, rettigheter per produkt, miljøer, rotasjon uten nedetid og hva du aldri bør gjøre med en nøkkel.
- Feilhåndtering · Ett feilformat for hele API-et.
- Hastighetsgrenser · Grenser per plan, hvordan du leser RateLimit-hodene, og hvordan du bygger klienter som aldri treffer 429 i produksjon.
- Paginering · Markørbasert paginering på alle lister.
- Idempotens · Hvordan Idempotency-Key gjør at et gjenforsøk aldri oppretter to fakturaer, to signeringsjobber eller to SMS-er.
- Webhooks · Motta hendelser fra alle produktene som signerte HTTP-kall, med gjenforsøk i 72 timer, leveringslogg og mulighet for å sende på nytt.
- Versjonering · Datoversjoner, hva som regnes som en brytende endring, hvor lenge gamle versjoner støttes, og hvordan du oppgraderer trygt.
Produkter
- Oppslag i praksis · Søk, oppslag, roller, regnskap, konsern og masseoppslag.
- Faktura i praksis · Opprett, send og følg opp fakturaer.
- Signering i praksis · Velg nivå, send til signering, bygg flyten inn i produktet ditt, håndter flere parter og arkiver signerte dokumenter med bevis.
- Varsling i praksis · Send SMS, e-post og push med kanalregler, maler, tidsvinduer og batch.
- Adresse i praksis · Autofullfør i skjemaer, validering ved lagring, geokoding for ruter og kart, eiendomsinformasjon og massevask av registre.
Drift
- Sikkerhet i integrasjonen · Sjekkliste for en sikker Spire-integrasjon: nøkler, webhooks, personopplysninger, logging og hva du bør gjøre før du går live.
- Overvåking og feilsøking · Dashbordets logg, Spire-Request-Id, forbruksvarsler, statusabonnement og hvordan du feilsøker et kall som ikke gjorde det du trodde.
- Migrering fra v0 · Det uversjonerte v0-API-et slås av 1.