Fyrir þróun og forritun
Leiðbeiningar fyrir forritara í nokkrum skrefum.
Our goal is to make exchanging electronic business documents as easy and straightforward as possible.
Notkun
Markmið okkar er að gera samskipti með rafrænum skjölum eins einföld og góð og hægt er. API viðmótið hentar öllum forritirum óháð reynslu og forritunarumhverfi.
APInn fyrir skeytaskipti – Messaging API – hjálpar þér við að forrita sending og móttöku rafrænna viðskiptaskeyta fyrir viðskiptaaðila. Með því að nota MAPI getur seljandi sent reikninga til viðskiptamanns og kaupandi sent pöntun til seljanda og sótt reikninginn fyrir kaupunum.
Byrjaðu með að kynna þér Transactions – viðskiptasendingar – og hvernig senda á skjal sem byggt er upp úr lýsigögnum (metadata). Sendingarnar eru auðkenndar með HTTP Basic Authentication.
Fljótlegasta leiðin til að prófa MAPI viðmótið er gegnum Postman sem er öflugt og sveigjanlegt tól til að þróa og prófa API..
Messaging API – Transaction Services
Hér er einföld útskýring á notkun Transaction þjónusta til að senda og móttaka rafræn viðskiptaskjöl úr bakendakerfi, eða viðskiptakerfi. Nánari lýsingu má síðan finna á: https://apidocs.unimaze.com
Transaction þjónustur eru notaðar til að búa til eða tulka viðskiptaskjöl með JSON lýsigögnum, sem draga upplýsingar úr undirliggjandi XML eða EDI gögnum. Til að vinna með hráar XML skrár vinsamlegast sjáið Messaging API – Yfirlit yfir Messaging þjónustur.
Sending electronic documents
1. Búið til nýtt einkvæmt einkenni, GUID og geymi, þetta verður einkenni skeytisins, :mdi.
2. Búið til JSON skeytið og sendið með þeirri sendingaraðferð sem við á:
- POST /transactions/submit-invoice
- POST /transactions/correct-with-invoice
- POST /transactions/submit-order, etc.
Þegar send eru viðhengi þarf að tryggja að breytan more sé sett sem true. Þegar ekki þarf að senda frekari viðhengi er hún sett false og þá er skeytið sett í vinnslu.
3. Viðhengi eru send sem binary payload með:
- POST /messages/:mid/documents
Tegundin, ‘content-type’ verður að vera gild MIME tegund, og tegundir sem studdar eru eru myndir, PDF, XLSX, CSV og einfaldar textaskrár. Sem fyrr segir er breytan more sett sem true eða false eftir því sem við á.
4. Skoða má stöðu á skeyti með:
- GET messages/:mid/status
Svarið gefur bæði upplýsingar um afhendingu sem og snertingar og meðhöndlun.
Eftirfarandi stöður teljast lokastöður skeytis: a) Delivered – afhent, skeyti afhent til endapunkts, b) PendingReview – Bíður úrvinnslu (skeyti gæti innihaldið villur, athugið villur og aðvaranir á skeyti), c) Parked – Parkeruð (handvirkt sett í geymslu).
5. Geymið referenceId breytuna fyrir síðari tíma birtingu hvers skjals. [Sjá Móttöku hér fyrir neðan, lið 4.]
Móttaka rafrænna skjala
1. Sækja má lista af skeytum sem bíða móttöku using:
- GET /messages?status=pendingdelivery&transfer=inbound
Fyrir hvert skeyti skiptir einkvæma einkennið (GUID), action breytan og referenceId skjalsins mestu.
2. Skeytið er sótt með einu eftirfarandi kalla, og farið er eftir action breytunni hvað á við. Skjalinu er skilað á JSON formi.
- GET /transactions/submit-invoice?messageId=:mid
- GET /transactions/correct-with-credit?messageId=:mid
- GET /transactions/submit-order?messageId=:mid, etc.
3. Breytið stöðu skeytisins í móttekið:
- POST /messages/:mid/mark-as-delivered
Merkja á skeytið móttekið sem allra fyrst eftir móttöku.
4. Til að sýna notanda skjalið má nota:
- GET /messages/display/:referenceId (?lang= breytu má setja ef vill)