API-integrationsspecifikation

Det er gratis at udfylde online, kræver ingen konto og kan downloades som Word-dokument eller PDF. Se alle IT og projekter-skabeloner

• Integrationens navn

  For eksempel: Webshopordrer til regnskab

• Dokumentversion

  For eksempel: 1.0

• Skrevet af

  For eksempel: Hamza Idrissi

• Dato

  For eksempel: 5. april 2029

• Formål

  For eksempel: Send hver betalt webshopordre til regnskabssystemet som en salgsfaktura, så økonomi ikke skal indtaste den igen.

• System, der sender data

  For eksempel: Webshop (API v2)

• System, der modtager data

  For eksempel: Regnskabssystem (REST API)

• Dataflow

  For eksempel: 1. En kunde betaler for en ordre. 2. Webshoppen sender en webhook til integrationstjenesten. 3. Tjenesten omdanner ordren til en faktura og kalder regnskabs-API'en. 4. Regnskabssystemet returnerer et fakturanummer, som tjenesten gemmer på ordren.

• Endpoints og meddelelser

  Én række for hvert endpoint eller hver besked.

  For eksempel: POST /invoices | Opret en faktura | Body: kunde, linjer, moms, total | Returnerer: faktura-id og -nummer GET /customers?email= | Find en kunde | Returnerer: kunde-id eller tom POST /customers | Opret en kunde | Body: navn, e-mail, adresse

• Feltmapping

  Hvilket felt i kilden går til hvilket felt i målet. Angiv, hvordan værdier konverteres.

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

• Autentificering og sikkerhed

  For eksempel: OAuth 2.0 client credentials. Tokens varer en time. Hemmeligheder opbevares i vaulten, aldrig i kode. Alle kald bruger HTTPS. Webhooks signeres, og signaturen kontrolleres.

• Fejl og genforsøg

  For eksempel: Prøv igen ved 429 og 5xx op til 5 gange med stigende forsinkelser. Prøv ikke igen ved 4xx-fejl; log dem, og giv økonomi besked. Hver faktura har en unik nøgle, så et genforsøg ikke kan oprette en dublet.

• Grænser og mængder (valgfrit)valgfrit

  For eksempel: Regnskabs-API'en tillader 60 kald i minuttet. Der forventes 400 ordrer om dagen, op til 2.000 på udsalgsdage.

• Test

  For eksempel: Brug regnskabssystemets testmiljø. Test en normal ordre, en ordre med rabat, en refundering, en kunde, der allerede findes, og et API-nedbrud.

• Ejere og support

  For eksempel: Ejer: E-handelsteamet. Support: Hamza Idrissi. Eskalering: regnskabsleverandørens supportafdeling.

• Ændring og versionering (valgfrit)valgfrit

  For eksempel: Hver part giver 30 dages varsel om en brydende ændring.

1. 11. Formål
2. 22. Systemer
3. 33. Dataflow
4. 44. Endpoints og meddelelser
5. 55. Feltmapping
6. 66. Autentificering og sikkerhed
7. 77. Fejl og genforsøg
8. 88. Grænser og mængder
9. 99. Test
10. 1010. Ejere og support
11. 1111. Ændringer og versionering

1. 01

   Udfyld

   Skriv dine oplysninger i formularen. Dokumentet udfylder sig selv, mens du skriver. Klik på en tom plads for at springe til det tilhørende felt.

2. 02

   Kontrollér

   Læs det igennem. Felter, du ikke har udfyldt, forbliver markerede, så intet sendes afsted halvfærdigt.

3. 03

   Download

   Gem det som et Word-dokument for at redigere videre, eller som PDF for at sende eller printe.

Hvilke oplysninger beder denne skabelon om?

Formularen beder om 16 oplysninger, begyndende med Integrationens navn, Dokumentversion, Skrevet af, Dato, Formål. 2 flere er valgfrie.

Kan jeg downloade denne skabelon som Word eller PDF?

Ja. Når du har udfyldt formularen, kan du gemme den som et Word-dokument for at fortsætte redigeringen, eller som en PDF for at sende eller printe den. Det er gratis og kræver ingen konto.

Bliver det, jeg skriver, sendt nogen steder hen?

Nej. Det, du skriver, bliver i din browser, mens du udfylder dokumentet. Det sendes kun til nerix, hvis du vælger at åbne skabelonen i chatten.

Er disse skabeloner til it og projekter gratis?

De fleste. Udfyld og download dem gratis som Word eller PDF uden konto. Nogle få længere dokumenter er premium: gratis at udfylde, betalt én gang for at downloade og mærket med deres pris.

Gør en sikkerhedspolitik os sikre?

Intet dokument gør det alene. En politik hjælper, når den passer til det, folk faktisk gør. Hold den kort, forklar den for dit team, og gennemgå den hvert år.

Er et projektgrundlag kun for store projekter?

Nej. Også et lille projekt har gavn af det, for én side med mål, grænser og beslutningstager forhindrer de fleste uenigheder senere.

• ArkitekturbeslutningRegistrér en teknisk beslutning med kontekst, muligheder, begrundelse og konsekvenser, så teamet kan finde den senere.IT og projekter
• BYOD-politikFastlæg reglerne for brug af private telefoner og laptops til arbejde: sikkerhed, privatliv, support og udtræden.IT og projekter
• FejlrapportRapportér et softwareproblem, så en udvikler kan genskabe det, vurdere påvirkningen og rette det.IT og projekter
• ForandringsplanPlanlæg, hvordan medarbejderne bliver informeret, trænet og støttet gennem en stor forandring, og hvordan I ved, at det virkede.IT og projekter
• ÆndringsanmodningBed om en ændring af et projekt eller system, vis dens konsekvenser, og notér, om den er godkendt.IT og projekter
• Dokumentation for træning i cybersikkerhedsbevidsthedGem bevis på, at medarbejderne er trænet i phishing, adgangskoder og sikker arbejdsadfærd: emner, fremmøde og resultater.IT og projekter

Se alle IT og projekter-skabeloner