Müşderi API
ERP sistemiňizi göni Feronix-e birikdiriň — REST, HTTPS boýunça JSON, tenant-bagly, idempotensiýa we öň-barlag bilen.
API arkaly iberilen maglumatlar Feronix tarapyndan öz EORI we öz päsgä berme hasaplary astynda arylýar. Siz müşderi hökmünde eltme we eltme maglumatlaryny iberýärsiňiz; Feronix gümrük yglanyny bəyanətçi we nümayənd hökmünde amala aşyrýar. Haryt göni Feronix ambaryna eltilýär.
API haçan ulanmaly
Müşderi API ERP sistemlerinden (SAP, Microsoft Dynamics, Odoo, Oracle) awtomatiki geçirme we eltmeleri, parcel manifestlerini, eltme maglumaty we resminamalary awtomatiki geçirmek isleýän ähli integrasiýa senariýalary üçin ýoldur. Ol portalyň el bilen girizmesini çalşyr we ERP-den gümrüke çenli uçdan-uca awtomatikilaşdyrmagy mümkin edýär. Iberilen eltmeler Feronix ambary üçin niýetlenendir; Feronix gümrük prosesinde bəyanətçi we nümayənd hökmünde çyşýar.
Goldanýan girizilen formatlar
- Gurluşly REST payloadlar — HTTPS boýunça JSON
- JSON — aýratyn maglumat we kiçijik toplumlar üçin
- CSV — köp maglumat importu üçin
- NOVA-POSHTA iberme toplumlary — NOVA formatynda, madde setirleri parcel belgisi boýunça fiziki parcellere we olaryň esasy haryt maddelerine birikdirilýär
Garşy parcel ýazgy maglumatlary, gaýtalan ýa-da ýeten bellenmeler, nädogry mukdarlar, agramlar, HS kodlary we salgy komponentleri döretmezden öň tapylyar.
Hasaba alyş
curl -H 'X-Api-Key:' \ -H 'Accept-Language: de' \ https://atlas.feronix.tech/customer/me
Açar server tarapynda tenant-y kesgitleýär. Bedendäki customer_id
hiç wagt bu çägi giňeldmeli däldir. Goldanýan diller:
de, en, fr, es, zh, ru, uk.
API arkaly dolandyryp bilersiňiz
- Eltme döret
- Eltme we transport maglumatyny geçir
- Parcel sanawyny ýa-da madde-esasly manifest import et
- Parcelleri we haryt maddelerini birikdir
- Invoice, baha subutnamasy, T1 we beýleki resminamalary ýüklemek we bellen
- Barlamagy al
- IMPOST yglanyny aç-açan iber
- Ýagdaýy, säwlikleri, habarlary we resminamalary sora
- Säwlik maglumaty düzet we täze habar belgisi bilen täzeden iber
Maslahat berilýän yzygiderlilik
- T1 ýagdaýy kesgitläň — bar tranzit prosedurasy
bar bolsa, ilki
POST /warehouse/delivery-documents/t1. Täze T1 döredilmeli bolsa, eltmäniň içindet1_mode=creategoý. - Eltme döret —
POST /warehouse/delivery-manifestsmöhlet we doly parcel sanawy bilen eltme üçin. - Baha subutnamasyny ýükle —
POST /warehouse/value-evidenceinvoice/baha subutnamasy üçin. - Öň-barlag —
POST /customer/shipments/validateöň-barlag üçin. Üstünlikli barlag gümrüke hiç zat ibermeýär. - Eltme döret —
POST /customer/shipmentspayload laýyklykda döret/iber. - Ýagdaýy yzarla —
GET /customer/shipments/{lrn}we gümrük prosesiGET /customer/declarations/{lrn}arkaly. - T1 döret —
t1_mode=createbilen doly girizmeden soň,POST /warehouse/deliveries/{delivery_number}/t1-xmlarkaly T1 döret.
Idempotensiýa
Idempotensiýa açarlary network ýa-da skaner gaýtadan synanyşmalarynda gaýtadan döretmegi öňüni alýar. Logiki taýdan deň gaýtadan synanyşma şoýle daşarky salgy ýa-da idempotensiýa belgisi ulanmaly. Düzedilen täzeden iberme täze ATLAS habar belgisi alýar. Wagt çäsi ret etmek bilen deň däldir — täzeden synanyşmazdan öň, haýyş kabul edilenligini we diňe jogap ýitirilenligini barlaň.
Esas uçlar
| Metod | Uç | Maksat |
|---|---|---|
| POST | /warehouse/delivery-manifests | Eltme we parcelleri atomik döret (eltme Feronix ambaryna) |
| POST | /warehouse/value-evidence | Baha subutnamasyny ýükle |
| POST | /customer/shipments/validate | Öň-barlag (gümrüke hiç zat ibermeýär) |
| POST | /customer/shipments | Eltme döret/iber |
| GET | /customer/shipments/{lrn} | Eltme ýagdaýy |
| GET | /customer/shipments/{lrn}/impost-xml | IMPOST-XML eksport (ICOMDA) |
| GET | /customer/shipments/{lrn}/standard-clearance/dossier.pdf | Gümrük papkasy PDF |
| GET | /customer/shipments/{lrn}/standard-clearance/dossier.zip | Gümrük papkasy ZIP |
| POST | /customer/shipments/{lrn}/standard-clearance/atlas-xml | DECDFA-XML döret |
| GET | /customer/declarations/{lrn} | Habarlar we karar bilen gümrük prosesi |
| POST | /customer/declarations/{lrn}/resubmit | Düzedilen täzeden iberme |
| POST | /customer/suma/xml | SumA-XML eksport et |
| POST | /warehouse/transit-orders | Tranzit sargyty döret |
| POST | /warehouse/transit-orders/{id}/xml | T1-XML döret (DETPDD) |
| POST | /customer/customs-xml/validate | XML-i asyl XSD-e garany |
| GET | /customer/me | Tenant profili |
| GET | /customer/me/identities | Gümrük şahsyýetleri (EORI/NL) — Feronix-iň gümrük şahsyýetleri, olar astynda Feronix bəyanətçi hökmünde çyşýar, siziňki däl |
| GET | /customer/me/mandates | Wekillik mandatları — olar astynda Feronix siziň üçin gümrük prosesinde nümayənd hökmünde çyşýar |
| GET | /customer/reference/hs-search | HS kody gözlegi |
Säwlik kodlary
API säwlikleri HTTP ýagdaýy, stabil säwlik kody, lokalizirlenen tekst we mümkin bolanda, täsir edilen meýdan ýoluny öz içine alýar.
| Ýagdaý | Manysy | Hereket |
|---|---|---|
| 400 | Haýyş tehniki okap bolmaýar | JSON, charset ýa-da faýly barla |
| 401 | API açar ýok ýa-da nädogry | Dogry tenant-yň X-Api-Key iber |
| 403 | Rugsat ýok | Ulanjy roly ýa-da API tassyklamasyny barla |
| 404 | Obýekt tenant-da tapylmady | LRN, eltme belgisi, barkod we tenant-y barla |
| 409 | Logiki garşylyk | Ýagdaýy, ýöriteýetligi ýa-da bagly maglumaty düzet |
| 422 | Mejbury meýdan/baglylyk bozuldy | Meýdan-öýe maslahatlaryny doly işlemek |
| 500/502/503 | Tehniki säwlik | Soňsuz täzeden iberme — şoýle idempotensiýa açary bilen täzeden synanyş |