Administraatori paneelis: API → Raamatupidamissüsteemi API testimine.
Mis see on
Liivakast integratsiooniks teie raamatupidamissüsteemiga. Siia on koondatud kõik punktid, mille kaudu meie süsteem ise raamatupidamissüsteemi kutsub: küsib hindu, kontrollib laoseisu, tõmbab seoseid materjal↔serv jne. Lehel on näha, millised endpoint'id on teil seadistatud, millised mitte; iga ühte saab elavalt testida päris päringuga ja näha, mida raamatupidamissüsteem tagastas.
Mida te näete
Raamatupidamissüsteemi pöördumispunktide loend — sama struktuuriga kaardid:
- Nimi ja punkti lühikirjeldus.
- Mida see annab — lihtsate sõnadega: millise funktsionaalsuse selle endpoint'i seadistamine sisse lülitab.
- Seadistuse sammud — lühike juhis: mida küsida teie raamatupidamissüsteemi programmeerijalt, millise parameetri võtit administratoripaneelist leida, kuhu URL kleepida.
- Praegune URL — kui juba seadistatud. Tühi — tähendab, et endpoint ei tööta.
- Nupp „Test" — viib reaalse päringu vormiga sakile, näitab request/response.
Saadaolevad integratsioonipunktid
Põhikomplekt (võivad süsteemi arenguga lisanduda):
- Materjalide hindade saamine — meie süsteem küsib raamatupidamissüsteemist lehtmaterjalide ajakohaseid hindu. Ilma selle seadistuseta võetakse hinnad kohalikust andmebaasist ja võivad erineda raamatupidamissüsteemist.
- Teenuste hindade saamine — sama asi teenuste jaoks (töötlus, furnituur).
- Laoseisu kontroll — enne tellimuse tootmisse käivitamist küsib süsteem raamatupidamissüsteemilt, kas kõik vajalikud materjalid on olemas. Ilma selleta võivad tellimused minna tootmisse ja kukkuda „materjali pole" peale.
- Materjali serva saamine — milline serv tuleb komplektis konkreetse lehtmaterjaliga. Kasutatakse nomenklatuuri sünkroonimisel; vastasel juhul tuleb materjal→serv vastavus käsitsi seadistada.
Materjalide ja teenuste hindade päringul edastab platvorm raamatupidamissüsteemile tellimuse tegeliku vastaspoole — klient näeb oma lepingulisi hindu, mitte jaehindu. Kui vastaspoolt pole loodud või see pole raamatupidamissüsteemiga seotud, arvestus ei ebaõnnestu: tagastatakse jaehinnad koos arusaadava selgitusega, mida andmetes tuleb täiendada. Samuti on parandatud juhtum, kus ühe firma kasutaja töötab teise firma kataloogiga: hinnapäring läheb nüüd rangelt selle firma raamatupidamissüsteemi, kelle kataloogi kasutatakse.
Kuidas seadistada
Üldine retsept on iga punkti jaoks sama:
- Paluda oma raamatupidamissüsteemi programmeerijalt luua HTTP-teenus (endpoint) vajaliku päringu/vastuse vorminguga. Vormingu kirjeldus on testimislehel kaardi sees.
- Saada programmeerijalt selle teenuse URL (peab algama
https://; kohalik raamatupidamissüsteem võib ollahttp://peal). - Minna Parameetrid → Firma parameetrid, leida parameeter kaardil näidatud võtmega ja kleepida URL.
- Naasta testimislehele ja vajutada „Test" — kohe on näha, kas raamatupidamissüsteem vastab või mitte ja milliseid andmeid tagastab.
Päringu test
Valitud punkti testisakil näete:
- Endpoint URL — kuhu päring lendab.
- HTTP-meetod (tavaliselt POST).
- Päised (sealhulgas raamatupidamissüsteemi API-Key, kui on määratud).
- Päringu keha — tüüpiline näide, mida saab kohe saata või kohandada (näiteks asendades reaalse
code1c-ga olemasolevast tootest/tellimusest). - Nupp „Saada" — annab toore vastuse raamatupidamissüsteemilt: vastusekood, keha, kestus.
Mis on oluline
- Testpäringud on päris: need lähevad tõepoolest teie raamatupidamissüsteemi ja võivad muuta selle andmeid (näiteks test „Võta tellimus vastu" loob raamatupidamissüsteemi kirje). Olge tootmises ettevaatlik — testige esmalt staging-raamatupidamissüsteemi peal.
- Kõik punktide seaded on salvestatud teie firma tootmisparameetritesse — neid saab muuta ilma uuesti juurutamata.
- Ühes võtmetest on süsteemis ajalooline trükiviga („avilable" „available" asemel) — see ei ole viga, jäetud ühilduvuse pärast vanade installatsioonidega. Vihje kaardil hoiatab.
- Ligipääs — kõik teie firma administraatorid.