Testare API sistem de contabilitate

#305

În panoul de administrare: API → Testarea API sistem de contabilitate.

Ce este

Un sandbox pentru integrarea cu sistemul dumneavoastră contabil. Aici sunt adunate toate punctele prin care sistemul nostru singur apelează la sistemul de contabilitate: cere prețuri, verifică disponibilitatea în depozit, preia legăturile material↔cant etc. Pe pagină se vede ce endpoint-uri aveți configurate și care nu; fiecare poate fi testat în direct cu o cerere reală și se poate vedea ce a returnat sistemul de contabilitate.

Ce vedeți

Lista punctelor de apel către sistemul de contabilitate — carduri cu aceeași structură:

  • Denumire și o scurtă descriere a punctului.
  • Ce oferă — în cuvinte simple: ce funcționalitate activează configurarea acestui endpoint.
  • Pași de configurare — instrucțiuni scurte: ce să cereți programatorului dumneavoastră de sistem de contabilitate, ce cheie de parametru să găsiți în admin, unde să introduceți URL-ul.
  • URL curent — dacă este deja configurat. Gol — înseamnă că endpoint-ul nu funcționează.
  • Buton „Test" — duce la fila cu formularul cererii reale, afișează request/response.

Puncte de integrare disponibile

Setul de bază (pot fi adăugate pe măsură ce sistemul evoluează):

  • Obținerea prețurilor materialelor — sistemul nostru cere de la sistemul de contabilitate prețurile actuale ale materialelor plăcuite. Fără această configurare prețurile sunt preluate din baza locală și pot diferi de sistemul de contabilitate.
  • Obținerea prețurilor serviciilor — același lucru pentru servicii (prelucrare, feronerie).
  • Verificarea disponibilității în depozit — înainte de lansarea comenzii în producție sistemul întreabă sistemul de contabilitate dacă există toate materialele necesare. Fără acest lucru comenzile pot ajunge în producție și pot cădea cu „lipsă material".
  • Obținerea cantului pentru material — ce cant vine în pachet cu un anumit material plăcuit. Folosit la sincronizarea nomenclatorului; altfel corespondența material→cant trebuie configurată manual.

La cererea prețurilor pentru materiale și servicii, platforma trimite către sistemul de contabilitate contrapartida reală a comenzii — clientul vede prețurile sale contractuale, nu cele cu amănuntul. Dacă contrapartida nu este creată sau nu este legată de sistemul de contabilitate, calculul nu eșuează: se returnează prețurile cu amănuntul cu o explicație clară despre ce trebuie completat în date. De asemenea, a fost corectat cazul în care un utilizator al unei firme lucrează cu catalogul altei firme: cererea de prețuri merge acum strict la sistemul de contabilitate al firmei al cărei catalog este folosit.

Cum se configurează

Rețeta generală este aceeași pentru fiecare punct:

  1. Rugați programatorul dumneavoastră de sistem de contabilitate să creeze un serviciu HTTP (endpoint) cu formatul cerere/răspuns necesar. Descrierea formatului este în interiorul cardului de pe pagina de testare.
  2. Obțineți de la programator URL-ul acestui serviciu (trebuie să înceapă cu https://; sistemul de contabilitate local poate fi pe http://).
  3. Mergeți la Parametri → Parametrii firmei, găsiți parametrul cu cheia indicată în card și introduceți URL-ul.
  4. Reveniți pe pagina de testare și apăsați „Test" — imediat se vede dacă sistemul de contabilitate răspunde sau nu și ce date returnează.

Testarea cererii

Pe fila de test pentru punctul ales vedeți:

  • Endpoint URL — unde va merge cererea.
  • Metoda HTTP (de obicei POST).
  • Antete (inclusiv API-Key al sistemului de contabilitate dacă este setat).
  • Corpul cererii — un exemplu tipic care poate fi trimis imediat sau ajustat (de exemplu, să se introducă un code1c real al unui produs/comandă existent).
  • Butonul „Trimite" — oferă răspunsul brut de la sistemul de contabilitate: cod de răspuns, corp, durată.

Ce este important

  • Cererile de test sunt reale: ele merg într-adevăr în sistemul dumneavoastră de contabilitate și pot modifica datele acestuia (de exemplu, testul „Acceptă comanda" va crea o înregistrare în sistemul de contabilitate). Fiți atenți în producție — testați mai întâi pe un sistem de contabilitate de staging.
  • Toate setările punctelor sunt stocate în parametrii de producție ai firmei dumneavoastră — se pot modifica fără redeploy.
  • Într-una dintre chei există istoric o eroare de tipar în sistem („avilable" în loc de „available") — nu este un bug, este lăsat pentru compatibilitate cu instalări vechi. Indicația din card va avertiza.
  • Acces — toți administratorii firmei dumneavoastră.