Test API účtovného systému

#305

V admin paneli: API → Testovanie API účtovného systému.

Čo to je

Sandbox pre integráciu s vaším účtovným systémom. Tu sú zhromaždené všetky body, cez ktoré náš systém sám komunikuje s účtovným systémom: pýta si ceny, kontroluje dostupnosť na sklade, ťahá väzby materiál↔hrana atď. Na stránke vidieť, ktoré endpointy máte nastavené a ktoré nie; každý sa dá naživo otestovať s reálnou požiadavkou a vidieť, čo účtovný systém vrátil.

Čo vidíte

Zoznam bodov volania účtovného systému — karty s rovnakou štruktúrou:

  • Názov a krátky popis bodu.
  • Čo to dáva — jednoduchými slovami: akú funkcionalitu zapne nastavenie tohto endpointu.
  • Kroky nastavenia — krátka inštrukcia: čo poprosiť od vášho programátora účtovného systému, ktorý kľúč parametra nájsť v admine, kam vložiť URL.
  • Aktuálne URL — ak je už nastavené. Prázdne — znamená, že endpoint nefunguje.
  • Tlačidlo „Test" — prejde na záložku s formulárom reálnej požiadavky, ukazuje request/response.

Dostupné integračné body

Základná sada (môžu sa pridávať podľa vývoja systému):

  • Získanie cien materiálov — náš systém si žiada od účtovného systému aktuálne ceny doskových materiálov. Bez tohto nastavenia sa ceny berú z lokálnej databázy a môžu sa líšiť od účtovného systému.
  • Získanie cien služieb — to isté pre služby (opracovanie, kovanie).
  • Kontrola dostupnosti na sklade — pred spustením zákazky do výroby sa systém pýta účtovného systému, či sú všetky potrebné materiály. Bez toho zákazky môžu ísť do výroby a spadnúť na „chýba materiál".
  • Získanie hrany pre materiál — ktorá hrana ide v komplete s konkrétnym doskovým materiálom. Používa sa pri synchronizácii nomenklatúry; inak väzbu materiál→hrana treba nastavovať ručne.

Pri žiadosti o ceny materiálov a služieb platforma odosiela do účtovného systému skutočného obchodného partnera zákazky — klient vidí svoje zmluvné ceny, nie maloobchodné. Ak obchodný partner nie je založený alebo nie je prepojený s účtovným systémom, výpočet nezlyhá: vrátia sa maloobchodné ceny so zrozumiteľným vysvetlením, čo je potrebné doplniť v údajoch. Zároveň bol opravený prípad, keď používateľ jednej firmy pracuje s katalógom inej: požiadavka na ceny teraz ide striktne do účtovného systému tej firmy, ktorej katalóg sa používa.

Ako nastaviť

Všeobecný recept je pre každý bod rovnaký:

  1. Poprosiť vášho programátora účtovného systému, aby vytvoril HTTP-službu (endpoint) s potrebným formátom požiadavky/odpovede. Popis formátu — vnútri karty na stránke testovania.
  2. Získať od programátora URL tejto služby (musí začínať https://; lokálny účtovný systém môže byť na http://).
  3. Ísť do Parametre → Parametre firmy, nájsť parameter s kľúčom uvedeným v karte a vložiť URL.
  4. Vrátiť sa na stránku testovania a stlačiť „Test" — hneď vidieť, či účtovný systém odpovedá alebo nie, a aké údaje vracia.

Test požiadavky

Na záložke testu pre vybraný bod vidíte:

  • Endpoint URL — kam poletí požiadavka.
  • HTTP-metóda (zvyčajne POST).
  • Hlavičky (vrátane API-Key účtovného systému ak je zadaný).
  • Telo požiadavky — typický príklad, ktorý sa dá hneď odoslať alebo upraviť (napríklad, vložiť reálny code1c existujúceho tovaru/zákazky).
  • Tlačidlo „Odoslať" — dá surovú odpoveď z účtovného systému: kód odpovede, telo, trvanie.

Čo je dôležité

  • Testové požiadavky sú reálne: skutočne idú do vášho účtovného systému a môžu meniť jeho údaje (napríklad test „Prijať zákazku" vytvorí v účtovnom systéme záznam). Buďte opatrní na prode — najprv testujte na staging-verzii účtovného systému.
  • Všetky nastavenia bodov sa ukladajú vo výrobných parametroch vašej firmy — meniť sa dajú bez redeploya.
  • V jednom z kľúčov je v systéme historicky preklep („avilable" namiesto „available") — nie je to bug, ponechané pre kompatibilitu so starými inštaláciami. Nápoveda v karte upozorní.
  • Prístup — všetci admini vašej firmy.