Sari la conținut
Începe gratuit

Specificație de integrare API

Stabilește cum se conectează două sisteme: ce date circulă, cum sunt securizate, cum se tratează erorile și cine răspunde de integrare.

Completează și previzualizează

Specificație de integrare API

Integrare: Comenzi din magazinul online către contabilitate
Versiune: 1.0
Întocmit de: Hamza Idrissi
Data: 5 aprilie 2029

1. Scop

Trimite fiecare comandă plătită din magazinul online către sistemul de contabilitate ca factură de vânzare, astfel încât departamentul financiar să nu o introducă din nou.

2. Sisteme

  • Trimite date: Magazin online (API v2)
  • Primește date: Sistem de contabilitate (API REST)

3. Flux de date

1. Un client plătește o comandă.
2. Magazinul trimite un webhook către serviciul de integrare.
3. Serviciul transformă comanda în factură și apelează API-ul de contabilitate.
4. Sistemul de contabilitate returnează un număr de factură, pe care serviciul îl salvează pe comandă.

4. Endpointuri și mesaje

Metodă și cale Ce face Câmpuri principale Ce returnează
POST /invoices Creează o factură Corp: client, linii, taxe, total Returnează: id și număr factură
GET /customers?email= Găsește un client Returnează: id client sau gol
POST /customers Creează un client Corp: nume, email, adresă

5. Maparea câmpurilor

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

6. Autentificare și securitate

OAuth 2.0 cu credențiale de client. Tokenurile sunt valabile o oră. Secretele sunt păstrate în seif, niciodată în cod. Toate apelurile folosesc HTTPS. Webhookurile sunt semnate, iar semnătura este verificată.

Datele cu caracter personal se trimit doar atunci când este necesar, nu se scriu în jurnale și sunt acoperite de condițiile de confidențialitate ale ambelor sisteme.

7. Erori și reîncercări

Reîncearcă la 429 și 5xx de până la 5 ori, cu întârzieri crescătoare. Nu reîncerca erorile 4xx; înregistrează-le și anunță departamentul financiar. Fiecare factură are o cheie unică, astfel încât o reîncercare să nu creeze un duplicat.

8. Limite și volume

API-ul de contabilitate permite 60 de apeluri pe minut. Sunt așteptate 400 de comenzi pe zi, până la 2.000 în zilele cu reduceri.

9. Testare

Folosește mediul de test al sistemului de contabilitate. Testează o comandă normală, o comandă cu reducere, o rambursare, un client care există deja și o cădere a API-ului.

10. Responsabili și suport

Responsabil: echipa de e-commerce. Suport: Hamza Idrissi. Escaladare: serviciul de suport al furnizorului de contabilitate.

11. Modificări și versionare

Oricare parte anunță cu 30 de zile înainte o modificare care afectează compatibilitatea.

Modelele sunt un punct de plecare pregătit cu grijă, nu consultanță juridică. Când legea contează, verifică ce prevederi se aplică acolo unde te afli.

IT și proiecte

La ce folosește acest model

Cum se conectează două sisteme printr-o integrare API: scop, flux de date, endpointuri, autentificare, erori, limite, testare și responsabili.

Se completează online gratuit, nu cere cont și se descarcă ca document Word sau PDF. Vezi toate modelele din categoria IT și proiecte

IT și proiecte

Ce completezi

Formularul cere 16 date. Documentul se completează pe măsură ce scrii.

  • Numele integrării

    De exemplu: Comenzi din magazinul online către contabilitate

  • Versiunea documentului

    De exemplu: 1.0

  • Întocmit de

    De exemplu: Hamza Idrissi

  • Data

    De exemplu: 5 aprilie 2029

  • Scop

    De exemplu: Trimite fiecare comandă plătită din magazinul online către sistemul de contabilitate ca factură de vânzare, astfel încât departamentul financiar să nu o introducă din nou.

  • Sistemul care trimite date

    De exemplu: Magazin online (API v2)

  • Sistemul care primește date

    De exemplu: Sistem de contabilitate (API REST)

  • Flux de date

    De exemplu: 1. Un client plătește o comandă. 2. Magazinul trimite un webhook către serviciul de integrare. 3. Serviciul transformă comanda în factură și apelează API-ul de contabilitate. 4. Sistemul de contabilitate returnează un număr de factură, pe care serviciul îl salvează pe comandă.

  • Endpointuri și mesaje

    Un rând pentru fiecare punct final sau mesaj.

    De exemplu: POST /invoices | Creează o factură | Corp: client, linii, taxe, total | Returnează: id și număr factură GET /customers?email= | Găsește un client | Returnează: id client sau gol POST /customers | Creează un client | Corp: nume, email, adresă

  • Maparea câmpurilor

    Ce câmp din sursă ajunge în ce câmp din destinație. Menționează cum se convertesc valorile.

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

  • Autentificare și securitate

    De exemplu: OAuth 2.0 cu credențiale de client. Tokenurile sunt valabile o oră. Secretele sunt păstrate în seif, niciodată în cod. Toate apelurile folosesc HTTPS. Webhookurile sunt semnate, iar semnătura este verificată.

  • Erori și reîncercări

    De exemplu: Reîncearcă la 429 și 5xx de până la 5 ori, cu întârzieri crescătoare. Nu reîncerca erorile 4xx; înregistrează-le și anunță departamentul financiar. Fiecare factură are o cheie unică, astfel încât o reîncercare să nu creeze un duplicat.

  • Limite și volume (opțional)opțional

    De exemplu: API-ul de contabilitate permite 60 de apeluri pe minut. Sunt așteptate 400 de comenzi pe zi, până la 2.000 în zilele cu reduceri.

  • Testare

    De exemplu: Folosește mediul de test al sistemului de contabilitate. Testează o comandă normală, o comandă cu reducere, o rambursare, un client care există deja și o cădere a API-ului.

  • Responsabili și suport

    De exemplu: Responsabil: echipa de e-commerce. Suport: Hamza Idrissi. Escaladare: serviciul de suport al furnizorului de contabilitate.

  • Modificări și versionare (opțional)opțional

    De exemplu: Oricare parte anunță cu 30 de zile înainte o modificare care afectează compatibilitatea.

IT și proiecte

Ce conține

Părțile acestui document, în ordine.

  1. 11. Scop
  2. 22. Sisteme
  3. 33. Flux de date
  4. 44. Endpointuri și mesaje
  5. 55. Maparea câmpurilor
  6. 66. Autentificare și securitate
  7. 77. Erori și reîncercări
  8. 88. Limite și volume
  9. 99. Testare
  10. 1010. Responsabili și suport
  11. 1111. Modificări și versionare

Modele

Cum funcționează

  1. 01

    Completează

    Introdu datele tale în formular. Documentul se completează pe măsură ce scrii; apasă pe orice spațiu necompletat pentru a ajunge la câmpul corespunzător.

  2. 02

    Verifică

    Citește documentul integral. Spațiile pe care nu le-ai completat rămân marcate, ca să nu trimiți nimic neterminat.

  3. 03

    Descarcă

    Salvează-l ca document Word pentru a-l edita în continuare sau ca PDF pentru a-l trimite ori tipări.

Personalizează-l cu AI

Deschide-l în chat și cere modificări: mai scurt, mai ferm, pentru altă situație sau în altă limbă.

Adaptează-l cu nerix

IT și proiecte

Întrebări frecvente

Ce date cere acest model?

Formularul cere 16 date, începând cu Numele integrării, Versiunea documentului, Întocmit de, Data, Scop. Alte 2 sunt opționale.

Pot descărca acest model ca Word sau PDF?

Da. După ce ai completat formularul, salvează-l ca document Word pentru a-l edita în continuare sau ca PDF pentru a-l trimite ori tipări. Este gratuit și nu cere cont.

Ce scriu este trimis undeva?

Nu. Ce scrii rămâne în browserul tău cât timp completezi documentul. Ajunge la nerix doar dacă alegi să deschizi modelul în chat.

Sunt gratuite aceste șabloane pentru IT și proiecte?

Cele mai multe da. Completați-le și descărcați-le gratuit în Word sau PDF, fără cont. Câteva documente mai lungi sunt premium: gratuite de completat, plătite o singură dată la descărcare și marcate cu prețul lor.

Ne face siguri o politică de securitate?

Niciun document nu o face singur. O politică ajută când corespunde cu ce fac oamenii în realitate: păstreaz-o scurtă, explic-o echipei și revizuiește-o în fiecare an.

Este carta proiectului doar pentru proiecte mari?

Nu. Și un proiect mic are de câștigat, pentru că o pagină cu obiectivul, limitele și cel care decide previne cele mai multe certuri de mai târziu.

Modele

Vezi toate modelele din categoria IT și proiecte

Modele

Alte tipuri de documente

Fiecare categorie are propria pagină, ca să vezi dintr-o dată toate modelele ei.

Folosiți în nerix

Aflați mai mult