Apskaitos sistemos API testavimas

#305

Administratoriaus skydelyje: API → Apskaitos sistemos API testavimas.

Kas tai yra

Smėlio dėžė integracijai su jūsų apskaitos sistema. Čia surinkti visi taškai, per kuriuos mūsų sistema pati kreipiasi į apskaitos sistemą: prašo kainų, tikrina prieinamumą sandėlyje, traukia ryšius medžiaga↔briauna ir t. t. Puslapyje matosi, kurie endpoint'ai jums sukonfigūruoti, o kurie ne; kiekvieną galima realiai išbandyti su tikra užklausa ir pamatyti, ką grąžino apskaitos sistema.

Ką matote

Apskaitos sistemos kreipimosi taškų sąrašas — kortelės su ta pačia struktūra:

  • Pavadinimas ir trumpas taško aprašymas.
  • Ką tai duoda — paprastais žodžiais: kokį funkcionalumą įjungia šio endpoint'o konfigūracija.
  • Konfigūravimo žingsniai — trumpa instrukcija: ko paprašyti jūsų apskaitos sistemos programuotojo, kurį parametro raktą rasti administratoriaus skydelyje, kur įklijuoti URL.
  • Esamas URL — jei jau sukonfigūruotas. Tuščia — reiškia, kad endpoint'as neveikia.
  • Mygtukas „Testas" — pereina į kortelę su tikros užklausos forma, rodo request/response.

Prieinami integracijos taškai

Bazinis rinkinys (gali būti pridedami sistemai vystantis):

  • Medžiagų kainų gavimas — mūsų sistema prašo apskaitos sistemos aktualių lakštinių medžiagų kainų. Be šios konfigūracijos kainos imamos iš vietinės bazės ir gali skirtis nuo apskaitos sistemos.
  • Paslaugų kainų gavimas — tas pats paslaugoms (apdorojimas, furnitūra).
  • Prieinamumo sandėlyje patikrinimas — prieš paleisdama užsakymą į gamybą sistema klausia apskaitos sistemos, ar yra visos reikalingos medžiagos. Be to užsakymai gali patekti į gamybą ir nukristi su „nėra medžiagos".
  • Briaunos medžiagai gavimas — kokia briauna ateina komplekte su konkrečia lakštine medžiaga. Naudojama sinchronizuojant nomenklatūrą; kitaip atitikimą medžiaga→briauna tenka konfigūruoti rankiniu būdu.

Prašant medžiagų ir paslaugų kainų, platforma perduoda apskaitos sistemai tikrą užsakymo kontrahentą — klientas mato savo sutartines kainas, o ne mažmenines. Jei kontrahentas nesukurtas arba nesusietas su apskaitos sistema, skaičiavimas nenutrūksta: grąžinamos mažmeninės kainos su aiškiu paaiškinimu, ką reikia papildyti duomenyse. Taip pat ištaisytas atvejis, kai vienos įmonės naudotojas dirba su kitos įmonės katalogu: kainų užklausa dabar visada siunčiama į tos įmonės, kurios katalogas naudojamas, apskaitos sistemą.

Kaip sukonfigūruoti

Bendras receptas kiekvienam taškui vienodas:

  1. Paprašyti jūsų apskaitos sistemos programuotojo sukurti HTTP paslaugą (endpoint) su reikiamu užklausos/atsako formatu. Formato aprašymas — kortelės viduje testavimo puslapyje.
  2. Gauti iš programuotojo šios paslaugos URL (turi prasidėti https://; vietinė apskaitos sistema gali būti per http://).
  3. Eiti į Parametrai → Įmonės parametrai, rasti parametrą su kortelėje nurodytu raktu ir įklijuoti URL.
  4. Grįžti į testavimo puslapį ir paspausti „Testas" — iškart matosi, ar apskaitos sistema atsako, ir kokius duomenis grąžina.

Užklausos testas

Pasirinkto taško testo kortelėje matote:

  • Endpoint URL — kur lėks užklausa.
  • HTTP metodas (paprastai POST).
  • Antraštės (įskaitant apskaitos sistemos API-Key, jei nustatytas).
  • Užklausos kūnas — tipinis pavyzdys, kurį galima iškart išsiųsti arba pakoreguoti (pavyzdžiui, įstatyti tikrą code1c esamos prekės/užsakymo).
  • Mygtukas „Siųsti" — duoda neapdorotą atsaką iš apskaitos sistemos: atsako kodas, kūnas, trukmė.

Kas svarbu

  • Testinės užklausos yra tikros: jos iš tikrųjų eina į jūsų apskaitos sistemą ir gali keisti jo duomenis (pavyzdžiui, testas „Priimti užsakymą" sukurs apskaitos sistemoje įrašą). Būkite atsargūs produkcijoje — pirma testuokite staging apskaitos sistemoje.
  • Visi taškų nustatymai saugomi jūsų įmonės gamybiniuose parametruose — galima keisti be perdėto įdiegimo.
  • Viename iš raktų sistemoje istoriškai yra korektūros klaida („avilable" vietoj „available") — tai nėra klaida, palikta dėl suderinamumo su senomis instaliacijomis. Užuomina kortelėje įspės.
  • Prieiga — visi jūsų įmonės administratoriai.