Hoppa till innehåll

API-integrationsspecifikation

Beskriv hur två system kopplas ihop: vilken data som flyttas, hur den skyddas, hur fel hanteras och vem som äger lösningen.

Fyll i och förhandsgranska

API-integrationsspecifikation

Integration: Butiksordrar till redovisning
Version: 1.0
Skriven av: Hamza Idrissi
Datum: 5 april 2029

1. Syfte

Skicka varje betald webborder till redovisningssystemet som en säljfaktura, så att ekonomicontoret slipper skriva in den igen.

2. System

  • Skickar data: Webbplats (API v2)
  • Tar emot data: Redovisningssystem (REST API)

3. Dataflöde

1. En kund betalar en order.
2. Butiken skickar en webhook till integrationstjänsten.
3. Tjänsten gör om ordern till en faktura och anropar redovisningens API.
4. Redovisningssystemet returnerar ett fakturanummer som tjänsten sparar på ordern.

4. Endpoints och meddelanden

Metod och sökväg Vad den gör Huvudfält Vad den returnerar
POST /invoices Skapa en faktura Body: kund, rader, moms, totalt Returnerar: faktura-id och fakturanummer
GET /customers?email= Hitta en kund Returnerar: kund-id eller tomt
POST /customers Skapa en kund Body: namn, e-post, adress

5. Fältmappning

order.total_paid → invoice.total
order.billing_email → customer.email
order.items[].sku → line.product_code

6. Autentisering och säkerhet

OAuth 2.0 client credentials. Tokens gäller i en timme. Hemligheter förvaras i valvet, aldrig i kod. Alla anrop går över HTTPS. Webhooks signeras och signaturen kontrolleras.

Personuppgifter skickas bara när det behövs, skrivs inte till loggar och omfattas av båda systemens dataskyddsvillkor.

7. Fel och återförsök

Gör om försöket vid 429 och 5xx upp till 5 gånger med ökande väntetid. Försök inte igen vid 4xx-fel, logga dem och larma ekonomi. Varje faktura har en unik nyckel så att ett nytt försök inte kan skapa en dubblett.

8. Gränser och volymer

Redovisningens API tillåter 60 anrop per minut. Förväntat 400 ordrar per dag, upp till 2 000 på reapdagar.

9. Testning

Använd redovisningens sandlåda. Testa en normal order, en order med rabatt, en återbetalning, en kund som redan finns och ett avbrott i API:t.

10. Ägare och support

Ägare: E-handelsteamet. Support: Hamza Idrissi. Eskalering: redovisningsleverantörens support.

11. Ändringar och versionshantering

Båda sidor meddelar 30 dagar i förväg vid en brytande ändring.

Mallarna är en omsorgsfullt utformad utgångspunkt, inte juridisk rådgivning. När juridiken spelar roll bör du kontrollera vad som gäller där du befinner dig.

IT och projekt

Vad den här mallen är till för

En API-integrationsspecifikation som beskriver hur två system kopplas ihop: syfte, dataflöde, endpoints, autentisering, fel, gränser, testning och ansvar.

Den är gratis att fylla i online, kräver inget konto och laddas ner som ett Word-dokument eller en PDF. Se alla mallar i IT och projekt

IT och projekt

Det här fyller du i

Formuläret frågar efter 16 uppgifter. Dokumentet fylls i medan du skriver.

  • Integrationsnamn

    Till exempel: Butiksordrar till redovisning

  • Dokumentversion

    Till exempel: 1.0

  • Skriven av

    Till exempel: Hamza Idrissi

  • Datum

    Till exempel: 5 april 2029

  • Syfte

    Till exempel: Skicka varje betald webborder till redovisningssystemet som en säljfaktura, så att ekonomicontoret slipper skriva in den igen.

  • System som skickar data

    Till exempel: Webbplats (API v2)

  • System som tar emot data

    Till exempel: Redovisningssystem (REST API)

  • Dataflöde

    Till exempel: 1. En kund betalar en order. 2. Butiken skickar en webhook till integrationstjänsten. 3. Tjänsten gör om ordern till en faktura och anropar redovisningens API. 4. Redovisningssystemet returnerar ett fakturanummer som tjänsten sparar på ordern.

  • Endpoints och meddelanden

    En rad för varje slutpunkt eller meddelande.

    Till exempel: POST /invoices | Skapa en faktura | Body: kund, rader, moms, totalt | Returnerar: faktura-id och fakturanummer GET /customers?email= | Hitta en kund | Returnerar: kund-id eller tomt POST /customers | Skapa en kund | Body: namn, e-post, adress

  • Fältmappning

    Vilket fält i källan som går till vilket fält i målet. Ange hur värden konverteras.

    Till exempel: order.total_paid → invoice.total order.billing_email → customer.email order.items[].sku → line.product_code

  • Autentisering och säkerhet

    Till exempel: OAuth 2.0 client credentials. Tokens gäller i en timme. Hemligheter förvaras i valvet, aldrig i kod. Alla anrop går över HTTPS. Webhooks signeras och signaturen kontrolleras.

  • Fel och återförsök

    Till exempel: Gör om försöket vid 429 och 5xx upp till 5 gånger med ökande väntetid. Försök inte igen vid 4xx-fel, logga dem och larma ekonomi. Varje faktura har en unik nyckel så att ett nytt försök inte kan skapa en dubblett.

  • Gränser och volymer (valfritt)valfritt

    Till exempel: Redovisningens API tillåter 60 anrop per minut. Förväntat 400 ordrar per dag, upp till 2 000 på reapdagar.

  • Testning

    Till exempel: Använd redovisningens sandlåda. Testa en normal order, en order med rabatt, en återbetalning, en kund som redan finns och ett avbrott i API:t.

  • Ägare och support

    Till exempel: Ägare: E-handelsteamet. Support: Hamza Idrissi. Eskalering: redovisningsleverantörens support.

  • Ändringar och versionshantering (valfritt)valfritt

    Till exempel: Båda sidor meddelar 30 dagar i förväg vid en brytande ändring.

IT och projekt

Vad som finns i den

Dokumentets delar, i ordning.

  1. 11. Syfte
  2. 22. System
  3. 33. Dataflöde
  4. 44. Endpoints och meddelanden
  5. 55. Fältmappning
  6. 66. Autentisering och säkerhet
  7. 77. Fel och återförsök
  8. 88. Gränser och volymer
  9. 99. Testning
  10. 1010. Ägare och support
  11. 1111. Ändringar och versionshantering

Mallar

Så fungerar det

  1. 01

    Fyll i

    Skriv in dina uppgifter i formuläret. Dokumentet fylls i automatiskt medan du skriver. Klicka på en lucka för att gå till motsvarande fält.

  2. 02

    Kontrollera

    Läs igenom dokumentet. Luckor som du inte har fyllt i förblir markerade, så att inget skickas iväg halvfärdigt.

  3. 03

    Ladda ner

    Spara som ett Word-dokument för att redigera vidare, eller som en PDF för att skicka eller skriva ut.

Anpassa med AI

Öppna dokumentet i chatten och be om ändringar: kortare, mer bestämt, en annan situation eller ett annat språk.

Anpassa med nerix

IT och projekt

Frågor som människor ställer

Vilka uppgifter ber den här mallen om?

Formuläret frågar efter 16 uppgifter, med början i Integrationsnamn, Dokumentversion, Skriven av, Datum, Syfte. 2 till är valfria.

Kan jag ladda ner den här mallen som Word eller PDF?

Ja. När du har fyllt i formuläret sparar du det som ett Word-dokument för att redigera vidare, eller som en PDF för att skicka eller skriva ut. Det är gratis och kräver inget konto.

Skickas det jag skriver någonstans?

Nej. Det du skriver stannar i din webbläsare medan du fyller i dokumentet. Det går bara till nerix om du väljer att öppna mallen i chatten.

Är de här mallarna för IT och projekt gratis?

De flesta. Fyll i och ladda ner dem gratis som Word eller PDF, utan konto. Några längre dokument är premium: gratis att fylla i, betalas en gång för nedladdning och märkta med sitt pris.

Gör en säkerhetspolicy oss säkra?

Inget dokument gör det ensamt. En policy hjälper när den stämmer med vad folk faktiskt gör. Håll den kort, förklara den för teamet och se över den varje år.

Är ett projektdirektiv bara för stora projekt?

Nej. Även ett litet projekt har nytta av det, eftersom en sida med mål, gränser och beslutsfattare förhindrar de flesta tvister senare.