API-integrasjonsspesifikasjon

Det er gratis å fylle ut online, du trenger ingen konto, og du kan laste ned som Word-dokument eller PDF. Se alle maler for IT og prosjekter

• Navn på integrasjonen

  For eksempel: Nettbutikkordrer til regnskap

• Dokumentversjon

  For eksempel: 1.0

• Skrevet av

  For eksempel: Hamza Idrissi

• Dato

  For eksempel: 5. april 2029

• Formål

  For eksempel: Send hver betalte nettbutikkordre til regnskapssystemet som en salgsfaktura, slik at økonomiavdelingen ikke må legge den inn på nytt.

• Systemet som sender data

  For eksempel: Nettbutikk (API v2)

• Systemet som mottar data

  For eksempel: Regnskapssystem (REST API)

• Dataflyt

  For eksempel: 1. En kunde betaler for en ordre. 2. Nettbutikken sender en webhook til integrasjonstjenesten. 3. Tjenesten gjør ordren om til en faktura og kaller regnskaps-API-et. 4. Regnskapssystemet returnerer et fakturanummer, som tjenesten lagrer på ordren.

• Endepunkter og meldinger

  Én rad for hvert endepunkt eller hver melding.

  For eksempel: POST /invoices | Opprett en faktura | Body: kunde, linjer, mva, total | Returnerer: faktura-id og fakturanummer GET /customers?email= | Finn en kunde | Returnerer: kunde-id eller tomt POST /customers | Opprett en kunde | Body: navn, e-post, adresse

• Feltmapping

  Hvilket felt i kilden som går til hvilket felt i målet. Si hvordan verdier konverteres.

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

• Autentisering og sikkerhet

  For eksempel: OAuth 2.0 med client credentials. Tokens varer i én time. Hemmeligheter oppbevares i vaulten, aldri i koden. Alle kall bruker HTTPS. Webhooks signeres, og signaturen kontrolleres.

• Feil og gjenforsøk

  For eksempel: Gjenta forsøket ved 429 og 5xx opptil 5 ganger med økende forsinkelser. Ikke gjenta 4xx-feil; logg dem og varsle økonomi. Hver faktura har en unik nøkkel, slik at et gjenforsøk ikke kan opprette en dublett.

• Begrensninger og volumer (valgfritt)valgfritt

  For eksempel: Regnskaps-API-et tillater 60 kall per minutt. Forventet 400 ordrer per dag, opptil 2 000 på salgsdager.

• Testing

  For eksempel: Bruk sandkassemiljøet til regnskapet. Test en normal ordre, en ordre med rabatt, en refusjon, en kunde som allerede finnes, og et API-avbrudd.

• Eiere og brukerstøtte

  For eksempel: Eier: E-handelsteamet. Brukerstøtte: Hamza Idrissi. Eskalering: brukerstøtten til regnskapsleverandøren.

• Endring og versjonering (valgfritt)valgfritt

  For eksempel: Hver part varsler 30 dager før en endring som bryter kompatibiliteten.

1. 11. Formål
2. 22. Systemer
3. 33. Dataflyt
4. 44. Endepunkter og meldinger
5. 55. Feltmapping
6. 66. Autentisering og sikkerhet
7. 77. Feil og gjenforsøk
8. 88. Begrensninger og volumer
9. 99. Testing
10. 1010. Eiere og brukerstøtte
11. 1111. Endringer og versjonering

1. 01

   Fyll ut

   Skriv inn opplysningene dine i skjemaet. Dokumentet fyller seg ut mens du skriver. Klikk på en ledig plass for å gå til feltet.

2. 02

   Kontroller

   Les gjennom. Ledige plasser du ikke har fylt ut, forblir merket, slik at ingenting sendes ut halvferdig.

3. 03

   Last ned

   Lagre det som et Word-dokument for å redigere videre, eller som PDF for å sende eller skrive ut.

Hvilke opplysninger ber denne malen om?

Skjemaet ber om 16 opplysninger, og starter med Navn på integrasjonen, Dokumentversjon, Skrevet av, Dato, Formål. 2 flere er valgfrie.

Kan jeg laste ned denne malen som Word eller PDF?

Ja. Når du har fylt ut skjemaet, kan du lagre det som et Word-dokument for å fortsette å redigere, eller som PDF for å sende eller skrive ut. Det er gratis og krever ingen konto.

Blir det jeg skriver sendt noe sted?

Nei. Det du skriver, blir i nettleseren din mens du fyller ut dokumentet. Det sendes bare til nerix hvis du velger å åpne malen i chatten.

Er disse malene for IT og prosjekter gratis?

De fleste. Fyll dem ut og last dem ned gratis som Word eller PDF, uten konto. Noen få lengre dokumenter er premium: gratis å fylle ut, betalt én gang for nedlasting og merket med prisen.

Gjør en sikkerhetspolicy oss trygge?

Ingen dokumenter gjør det alene. En policy hjelper når den stemmer med det folk faktisk gjør. Hold den kort, forklar den for teamet og gå gjennom den hvert år.

Er et prosjektmandat bare for store prosjekter?

Nei. Også et lite prosjekt har nytte av det, for én side med mål, grenser og beslutningstaker hindrer de fleste uenigheter senere.

• ArkitekturvalgRegistrer et teknisk valg med kontekst, alternativer, begrunnelse og konsekvenser, slik at teamet finner det senere.IT og prosjekter
• Retningslinjer for egne enheterSett reglene for bruk av private telefoner og PC-er i arbeid: sikkerhet, personvern, støtte og avslutning.IT og prosjekter
• FeilrapportRapporter et programvareproblem slik at en utvikler kan gjenta det, vurdere konsekvensene og rette det.IT og prosjekter
• EndringsplanPlanlegg hvordan folk blir informert, opplært og fulgt opp gjennom en stor endring, og hvordan dere vet at det virket.IT og prosjekter
• EndringsforespørselBe om en endring i et prosjekt eller system, vis konsekvensene og før inn om den er godkjent.IT og prosjekter
• Protokoll for cybersikkerhetsopplæringDokumenter at de ansatte har fått opplæring i phishing, passord og trygg arbeidsmåte: temaer, deltakelse og resultater.IT og prosjekter

Se alle maler for IT og prosjekter