Přeskočit na obsah
Začít zdarma

Specifikace integrace API

Určete, jak se dva systémy propojují: jaká data se přenášejí, jak jsou zabezpečena, jak se řeší chyby a kdo za to odpovídá.

Vyplňte a zobrazte náhled

Specifikace integrace API

Integrace: Objednávky z e-shopu do účetnictví
Verze: 1.0
Zpracoval: Hamza Idrissi
Datum: 5. dubna 2029

1. Účel

Odeslat každou zaplacenou objednávku z webového e-shopu do účetního systému jako prodejní fakturu, aby ji finanční oddělení nemuselo přepisovat.

2. Systémy

  • Odesílá data: Webový e-shop (API v2)
  • Přijímá data: Účetní systém (REST API)

3. Tok dat

1. Zákazník zaplatí objednávku.
2. E-shop odešle webhook integrační službě.
3. Služba převede objednávku na fakturu a zavolá účetní API.
4. Účetní systém vrátí číslo faktury, které služba uloží k objednávce.

4. Koncové body a zprávy

Metoda a cesta Co dělá Hlavní pole Co vrací
POST /invoices Vytvoří fakturu Tělo: zákazník, řádky, daň, celkem Vrací: id a číslo faktury
GET /customers?email= Najde zákazníka Vrací: id zákazníka nebo prázdnou hodnotu
POST /customers Vytvoří zákazníka Tělo: jméno, e-mail, adresa

5. Mapování polí

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

6. Ověřování a zabezpečení

OAuth 2.0 client credentials. Tokeny platí jednu hodinu. Tajné údaje se uchovávají v trezoru, nikdy v kódu. Všechna volání používají HTTPS. Webhooky jsou podepsané a podpis se kontroluje.

Osobní údaje se odesílají jen tehdy, když je to nutné, nezapisují se do protokolů a vztahují se na ně zásady ochrany soukromí obou systémů.

7. Chyby a opakované pokusy

Při chybách 429 a 5xx opakujte pokus až 5krát s rostoucím zpožděním. Chyby 4xx neopakujte, zaznamenejte je a upozorněte finanční oddělení. Každá faktura má jedinečný klíč, takže opakovaný pokus nemůže vytvořit duplikát.

8. Limity a objemy

Účetní API povoluje 60 volání za minutu. Očekává se 400 objednávek denně, až 2 000 ve dnech výprodeje.

9. Testování

Použijte účetní sandbox. Otestujte běžnou objednávku, objednávku se slevou, vrácení peněz, zákazníka, který už existuje, a výpadek API.

10. Vlastníci a podpora

Vlastník: tým elektronického obchodu. Podpora: Hamza Idrissi. Eskalace: podpora dodavatele účetního systému.

11. Změny a verzování

Každá strana oznámí zásadní změnu 30 dní předem.

Šablony jsou pečlivým výchozím bodem, nikoli právním poradenstvím. Kde záleží na právu, ověřte, co platí tam, kde se nacházíte.

IT a projekty

K čemu je tato šablona

Specifikace integrace API popisuje, jak se dva systémy propojují: účel, tok dat, koncové body, ověřování, chyby, limity, testování a odpovědnost.

Vyplnit online je zdarma, nepotřebujete účet a dokument si stáhnete ve formátu Word nebo PDF. Zobrazit všechny šablony v kategorii IT a projekty

IT a projekty

Co vyplníte

Formulář vyžaduje 16 údajů. Dokument se vyplňuje sám, jak píšete.

  • Název integrace

    Například: Objednávky z e-shopu do účetnictví

  • Verze dokumentu

    Například: 1.0

  • Zpracoval

    Například: Hamza Idrissi

  • Datum

    Například: 5. dubna 2029

  • Účel

    Například: Odeslat každou zaplacenou objednávku z webového e-shopu do účetního systému jako prodejní fakturu, aby ji finanční oddělení nemuselo přepisovat.

  • Systém, který odesílá data

    Například: Webový e-shop (API v2)

  • Systém, který přijímá data

    Například: Účetní systém (REST API)

  • Tok dat

    Například: 1. Zákazník zaplatí objednávku. 2. E-shop odešle webhook integrační službě. 3. Služba převede objednávku na fakturu a zavolá účetní API. 4. Účetní systém vrátí číslo faktury, které služba uloží k objednávce.

  • Koncové body a zprávy

    Jeden řádek pro každou koncovou adresu nebo zprávu.

    Například: POST /invoices | Vytvoří fakturu | Tělo: zákazník, řádky, daň, celkem | Vrací: id a číslo faktury GET /customers?email= | Najde zákazníka | Vrací: id zákazníka nebo prázdnou hodnotu POST /customers | Vytvoří zákazníka | Tělo: jméno, e-mail, adresa

  • Mapování polí

    Které pole ve zdroji odpovídá kterému poli v cíli. Uveďte, jak se hodnoty převádějí.

    Například: order.total_paid → invoice.total order.billing_email → customer.email order.items[].sku → line.product_code

  • Ověřování a zabezpečení

    Například: OAuth 2.0 client credentials. Tokeny platí jednu hodinu. Tajné údaje se uchovávají v trezoru, nikdy v kódu. Všechna volání používají HTTPS. Webhooky jsou podepsané a podpis se kontroluje.

  • Chyby a opakované pokusy

    Například: Při chybách 429 a 5xx opakujte pokus až 5krát s rostoucím zpožděním. Chyby 4xx neopakujte, zaznamenejte je a upozorněte finanční oddělení. Každá faktura má jedinečný klíč, takže opakovaný pokus nemůže vytvořit duplikát.

  • Limity a objemy (volitelné)nepovinné

    Například: Účetní API povoluje 60 volání za minutu. Očekává se 400 objednávek denně, až 2 000 ve dnech výprodeje.

  • Testování

    Například: Použijte účetní sandbox. Otestujte běžnou objednávku, objednávku se slevou, vrácení peněz, zákazníka, který už existuje, a výpadek API.

  • Vlastníci a podpora

    Například: Vlastník: tým elektronického obchodu. Podpora: Hamza Idrissi. Eskalace: podpora dodavatele účetního systému.

  • Změny a verzování (volitelné)nepovinné

    Například: Každá strana oznámí zásadní změnu 30 dní předem.

IT a projekty

Co je uvnitř

Jednotlivé části dokumentu tak, jak jdou po sobě.

  1. 11. Účel
  2. 22. Systémy
  3. 33. Tok dat
  4. 44. Koncové body a zprávy
  5. 55. Mapování polí
  6. 66. Ověřování a zabezpečení
  7. 77. Chyby a opakované pokusy
  8. 88. Limity a objemy
  9. 99. Testování
  10. 1010. Vlastníci a podpora
  11. 1111. Změny a verzování

Šablony

Jak to funguje

  1. 01

    Vyplnění

    Zadejte své údaje do formuláře. Dokument se vyplňuje, jak píšete; kliknutím na kteroukoli mezeru přejdete na její pole.

  2. 02

    Kontrola

    Přečtěte si jej celý. Prázdná místa, která jste nevyplnili, zůstanou označená, takže nic neodejde nedokončené.

  3. 03

    Stažení

    Uložte jej jako dokument Word pro další úpravy nebo jako PDF k odeslání či tisku.

Přizpůsobte si jej pomocí AI

Otevřete jej v chatu a požádejte o změny: kratší, důraznější, pro jinou situaci, v jiném jazyce.

Přizpůsobit s nerix

IT a projekty

Časté dotazy

Jaké údaje tato šablona vyžaduje?

Formulář vyžaduje 16 údajů, nejprve Název integrace, Verze dokumentu, Zpracoval, Datum, Účel. 2 dalších je nepovinných.

Mohu si tuto šablonu stáhnout ve formátu Word nebo PDF?

Ano. Po vyplnění formuláře jej uložte jako dokument Word, abyste mohli dál upravovat, nebo jako PDF k odeslání či tisku. Je to zdarma a nepotřebujete účet.

Odesílá se někam to, co napíšu?

Ne. Co napíšete, zůstává ve vašem prohlížeči během vyplňování dokumentu. Do nerix se odešle jen tehdy, když se rozhodnete šablonu otevřít v chatu.

Jsou tyto šablony pro IT a projekty zdarma?

Většina ano. Vyplňte a stáhněte je zdarma jako Word nebo PDF, bez účtu. Několik delších dokumentů je prémiových: vyplnění zdarma, stažení za jednorázovou platbu a s uvedenou cenou.

Zajistí nám bezpečnostní směrnice bezpečí?

Žádný dokument to sám nezajistí. Směrnice pomáhá, když odpovídá tomu, co lidé skutečně dělají: držte ji krátkou, vysvětlete ji týmu a každý rok ji revidujte.

Je zakládací listina projektu jen pro velké projekty?

Ne. I malý projekt z ní těží, protože jedna stránka s cílem, hranicemi a rozhodující osobou předejde většině pozdějších sporů.

Šablony

Zobrazit všechny šablony v kategorii IT a projekty

Šablony

Další druhy dokumentů

Každá kategorie má vlastní stránku, takže si můžete prohlédnout všechny její šablony najednou.

Použijte to v nerix

Zjistěte více