Vývoj API
E-shop môže požiadavku na rezerváciu odoslať dvakrát, napríklad po prerušení spojenia. Pri návrhu API preto dohodneme, podľa ktorého identifikátora sklad spozná tú istú objednávku, čo vráti e-shopu a kde obchodník nájde nevyriešenú chybu.
Čo dodáme
Návrh rozhrania
Zrozumiteľné názvy, jednotné pravidlá a jasné chybové hlásenia.
Dokumentácia
Partner dostane popis polí, povinných hodnôt a odpovedí vrátane príkladu už spracovanej objednávky a prípadu, ktorý má opraviť.
Zabezpečenie
Prístupové kľúče, oprávnenia a obmedzenie počtu volaní.
Verzie
Zmeny zavádzame tak, aby existujúce napojenia fungovali ďalej.
Sledovanie
Vidíte, kto rozhranie používa, ako často a kde vznikajú chyby.
Testovacie prostredie
Partneri si napojenie vyskúšajú bez rizika pre ostré údaje.
Príklad: napojenie e-shopu partnera na váš sklad
- 1
Partner potrebuje zásoby
Chce každú hodinu vedieť, koľko kusov máte skladom.
- 2
Navrhneme rozhranie
Dohodneme, či API vracia fyzický stav alebo množstvo dostupné po odpočítaní rezervácií. Odpoveď obsahuje aj čas platnosti stavu.
- 3
Obmedzíme prístup
Partner vidí len zásoby, nie ceny nákupu ani iných zákazníkov.
- 4
Zdokumentujeme
Popis s príkladmi, podľa ktorého sa napojí jeho vývojár bez našej pomoci.
- 5
Sledujeme
Vidíte, kedy sa partner pýtal a či nevznikli chyby.
Časté otázky: Vývoj API
Kedy potrebujeme vlastné API?
Keď chcete, aby na váš systém nadväzovali iné programy: e-shop, mobilná aplikácia, systém partnera alebo zákazníka.
Čo ak druhá strana API nemá?
Riešením býva výmena súborov, e-mailov alebo priame čítanie z databázy. Vyberieme najspoľahlivejšiu dostupnú cestu.
Prepojenie e-shopu so skladom a účtovníctvom
Modelová objednávka ukazuje, ako sa identifikátor prenáša medzi systémami, kde sa mení dostupnosť tovaru a kedy má vzniknúť podklad pre účtovníctvo.
Čo má klient API vedieť o neúplnom výsledku
Rozhranie na import dávky môže prijať všetky riadky naraz alebo spracovať každý samostatne. Obe možnosti sú použiteľné, ak má príjemca presný význam odpovede. Zmluva rozhrania má preto určiť identifikátory jednotlivých položiek, označenie chýb, rozsah potvrdeného zápisu a pravidlá opakovania.
Pri integračnej skúške odošlite tri platné položky a jednu chybnú. Po oprave chyby musí klient vedieť rozhodnúť, či opakovať celý súbor alebo iba jednu položku. Pri stránkovaných výpisoch dohodnite aj stabilné poradie a správanie pri súbežnom pribúdaní záznamov, aby synchronizácia nevynechala nové údaje.
Zrušenie na strane klienta nemusí zrušiť spracovanie na serveri
Aplikácia odošle žiadosť na vytvorenie rozsiahleho exportu. Používateľ následne zavrie kartu prehliadača. Podľa návrhu služby môže úloha na pozadí pokračovať, preto klient potrebuje rozlišovať ukončenie spojenia, stav úlohy a úspešné dokončenie celého výstupu.
Pre rozhranie dohodnite identitu úlohy, povolené stavy a spôsob získania výsledku po novom prihlásení. Pri skúške ukončite klientske spojenie počas spracovania. Po návrate môže používateľ nájsť existujúci export a rozhodnúť sa, či ho stiahne, zruší alebo zadá ďalší s inými podmienkami.
Otázky z praxe
Ako navrhnúť stránkovanie zoznamu, ktorý sa počas čítania mení?
Určte stabilné zoradenie a pravidlo, podľa ktorého klient nadviaže ďalšou časťou. Pri meniacich sa údajoch môže byť potrebný kurzor alebo vyhradený okamih snímky. Klient musí vedieť, či dostáva aktuálny pohľad, alebo konzistentný export, a ako má zachytiť neskoršie vložené záznamy.
Čo má rozhranie vrátiť pri odmietnutí jednej položky v dávke?
Dohodnite, či má dávka uspieť naraz, alebo sa dajú jednotlivé riadky spracovať samostatne. Výsledok potom potrebuje identifikátor riadka, stav a dôvod odmietnutia použiteľný pre opravu. Pri opakovaní má klient vedieť poslať len nevybavené položky alebo bezpečne zopakovať pôvodný celok.
Ako zachovať prístup starším odberateľom pri zmene významu poľa?
Pri zmene významu má klient dostať spôsob, ako odlíšiť starú a novú interpretáciu, napríklad novú verziu alebo nové pole s výslovným popisom. Na test vyberte aj uložené staršie údaje. V komunikácii uveďte spôsob prechodu a podmienky, podľa ktorých sa vyhodnotí jeho dokončenie.
Súvisiace stránky
-
Integrácie
Integrácia firemných systémov prepojí e-shop, sklad a účtovníctvo. Pozrite si, čo sa prenáša pri objednávke a ako systém rieši výpadok či duplicitný záznam.
Otvoriť -
Databázy
Navrhneme štruktúru firemnej databázy, väzby medzi záznamami a migráciu z tabuliek. Uvidíte, ako zachovať zákazky pri spájaní duplicít.
Otvoriť -
Node.js
Backend v Node.js pre e-shopy, portály a rozhrania API. Navrhneme prenos objednávok, úlohy na pozadí a riešenie oneskorených odpovedí skladu.
Otvoriť