Forbróirí

API seiceála custaim

An tseiceáil chéanna agus atá ar an suíomh seo, arna glaoch ó do bhogearraí féin. Seolann tú comhad i JSON agus faigheann tú scór as 100, na pointí bacainneacha, na rabhaidh agus na gníomhartha molta — le cóid mhíchruinnis sheasmhacha agus teachtaireachtaí i 24 teanga oifigiúla an Aontais Eorpaigh.

Cruthaigh eochair Sonraíocht OpenAPI

Is API freastalaí-go-freastalaí é seo. Is rún í eochair API. Ní thacaítear le glaonna ó bhrabhsálaí agus ní sheoltar aon cheanntásc CORS ar bhealaí fíordheimhnithe: is eochair sceite í eochair a shroicheann brabhsálaí.

Forbhreathnú

Nochtann an API inneall seiceála an bhailíochtóra: trí riail déag trasréimse, ceithre riail maidir le hiomláine na ndoiciméad, agus na bailíochtóirí a bhaineann le gach córas dearbhaithe. Ní chuireann sé aon rud isteach agus ní cheistíonn sé aon bhunachar taraife — seiceálann sé comhsheasmhacht inmheánach agus formáid do chomhaid sula n-ullmhaíonn tú an dearbhú.

Tá réimír a leagain ar gach bealach. Tá na bealaí fionnachtana agus an tsonraíocht poiblí: is féidir le comhtháthaitheoir, nó le gníomhaire, an scéimre a léamh sula mbíonn eochair aige.

Bealach	Ról	Fíordheimhniú
POST/v1/checks	Seiceálann comhad agus cuireann an tuairisc iomlán ar ais	Eochair ag teastáil
POST/v1/checks/batch	Seiceálann suas le 25 comhad in aon ghlao amháin	Eochair ag teastáil
GET/v1/me	Cuireann an eochair reatha agus a cuóta ar ais, gan é a ídiú	Eochair ag teastáil
GET/v1/declaration-types	Liostaíonn na cineálacha dearbhaithe a aithnítear	Poiblí
GET/v1/declaration-types/{type}	Déanann cur síos ar na réimsí a bhfuiltear ag súil leo do chineál	Poiblí
GET/v1/openapi.json	Sonraíocht OpenAPI 3.1 an API seo	Poiblí

Fíordheimhniú

Fíordheimhníonn an API le comhartha iompróra. Ní thaispeántar an comhartha ach uair amháin, agus é á chruthú: ní choinnítear ach a rian, mar sin cuirtear eochair chaillte in ionad a chéile, ní aisghabhtar riamh í.

Is féidir leat trí eochair ghníomhacha a choinneáil ag an am céanna, rud a ligeann duit eochair a rothlú gan do chomhtháthú a bhriseadh: cruthaigh an ceann nua, cuir i bhfeidhm é, ansin cúlghair an seancheann.

1Cruthaigh eochair ó do chuntas, faoi „Eochracha API“.
2Seol í i gceanntásc Authorization gach iarratais.
3Cúlghair í má sceitheann sí: bíonn an briseadh láithreach, agus scriostar ábhar na gcomhad a cuireadh isteach leis an eochair sin láithreach.

Authorization: Bearer cc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

An chéad seiceáil

Tá comhad comhdhéanta de chineál, de cheanntásc agus de línte earraí. Is teaghráin iad na luachanna go léir: tugann an t-inneall aire dá léirmhíniú. Faightear amach ainmneacha na réimsí ag am rite, cineál ar chineál.

Tagann an freagra ar ais láithreach; níl aon rud le ceistiú ina dhiaidh sin.

Iarratas

curl https://www.customs-check.com/api/v1/checks \
  -H "Authorization: Bearer $CUSTOM_CHECK_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "import-export",
    "reference": "PO-2026-114",
    "header": {
      "flow": "IM",
      "shipmentCountry": "CN",
      "destinationCountry": "FR",
      "incoterm": "FOB",
      "companyName": "Acme SAS",
      "companyCountry": "FR",
      "eori": "FR12345678900012",
      "transportMode": "sea",
      "currency": "USD",
      "invoiceTotal": "12500"
    },
    "items": [
      {
        "description": "Leather sport shoes",
        "hsCode": "6403990000",
        "quantity": "500",
        "value": "12500",
        "origin": "VN",
        "grossMass": "850",
        "netMass": "800"
      }
    ],
    "documents": { "commercialInvoice": "available", "packingList": "missing" }
  }'

An freagra a léamh

Iompraíonn gach míchruinneas aitheantas meaisín agus abairt inléite araon. Tóg do loighic ar an aitheantas meaisín: ní athraíonn sé gan athrú leagain.

severity · code · path · rule: Conradh seasmhachSeasmhach. D'fhéadfadh cóid nua teacht chun cinn; ní athainmnítear cinn atá ann cheana gan athrú leagain.
field · message · text: Taispeáint amháinAistrithe le taispeáint. Is féidir iad a athfhoclú am ar bith — ná déan comparáid eatarthu i do chód riamh.
engine.version: Athraíonn sé a luaithe a bhogann athrú riail scór comhaid gan athrú. Cuir i gcartlann é in éineacht le do thuairiscí.

Léiríonn an réimse „path“ cruth d'iarratais, ionas gur féidir leat míchruinneas a nascadh go díreach leis an réimse comhfhreagrach i do chomhéadan féin.

header.<réimse> · items.<n>.<réimse> · documents.<category> · global

Freagra

{
  "id": "4c749e25-3408-48f9-b3ca-b18a7ad84681",
  "createdAt": "2026-09-16T12:46:13.186Z",
  "type": "import-export",
  "locale": "en",
  "reference": "PO-2026-114",
  "score": 90,
  "level": "good",
  "counts": { "errors": 0, "warnings": 2, "infos": 0 },
  "documents": { "commercialInvoice": "available", "packingList": "missing" },
  "issues": [
    {
      "severity": "warning",
      "code": "docPackingListMissing",
      "path": "documents.packingList",
      "rule": "DOC-002",
      "params": null,
      "field": "Packing list",
      "message": "Packing list not provided",
      "text": "Packing list not provided"
    },
    {
      "severity": "warning",
      "code": "docTransportMissing",
      "path": "documents.transportDocument",
      "rule": "DOC-003",
      "params": null,
      "field": "Transport document (B/L, AWB, CMR)",
      "message": "Transport document not provided",
      "text": "Transport document not provided"
    }
  ],
  "actions": [
    { "severity": "warning", "code": "docPackingListMissing",
      "path": "documents.packingList", "text": "Add: Packing list" }
  ],
  "tips": [],
  "engine": { "version": "1.0.0", "rules": 13 }
}

Na réimsí a fháil amach

Tá na cineálacha dearbhaithe agus a réimsí poiblí, níl aon eochair ag teastáil. Seo an bealach chun foirm a thógáil, mapáil ó do chóras ERP a bheathú, nó an scéimre atá le líonadh a thabhairt do ghníomhaire.

Is iad na hainmneacha a chuirtear ar ais anseo go beacht na heochracha atá le húsáid sa cheanntásc agus i ngach líne earraí. Cuirtear liostaí roghanna ar ais réitithe agus aistrithe; cuir an paraiméadar leis chun iad a fhágáil ar lár má bhraitheann an freagra ró-throm.

# The 8 declaration types
curl "https://www.customs-check.com/api/v1/declaration-types?locale=en"

# The fields of one type
curl "https://www.customs-check.com/api/v1/declaration-types/h7?locale=en"

# Same, without the resolved option lists
curl "https://www.customs-check.com/api/v1/declaration-types/h7?options=false"

Próiseáil bhaisce

Suas le 25 comhad in aghaidh an ghlao. Bíonn an freagra ina rath i gcónaí a luaithe a ghlactar leis an mbaisc, agus iompraíonn gach iontráil a stádas féin: ní chuireann aon chomhad míchumtha na cinn eile ó rath riamh.

Mura gclúdaíonn an cuóta atá fágtha gach iontráil bhailí, diúltaítear don bhaisc iomlán seachas í a phróiseáil go páirteach — ní gá duit buille faoi thuairim a thabhairt riamh faoi cár stad an phróiseáil.

curl https://www.customs-check.com/api/v1/checks/batch \
  -H "Authorization: Bearer $CUSTOM_CHECK_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "checks": [ { "type": "h7", "header": {}, "items": [] } ] }'

Cuóta

Faigheann gach eochair 500 seiceáil in aghaidh an lae fhéilire UTC. Taistealaíonn an staid reatha le gach freagra fíordheimhnithe, mar sin ní bhíonn glao breise ag teastáil uait riamh chun í a léamh.

Cuirtear glaonna diúltaithe san áireamh freisin: cliant a bhíonn ag lúbadh ar iarratais neamhbhailí, cuireann sé srian air féin. Socraítear an cuóta in aghaidh na heochrach — scríobh chugainn má theastaíonn níos mó uait.

Freagra

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 437
X-RateLimit-Reset: 1789603200
X-RateLimit-Policy: 500;w=86400

Earráidí

Níl na teachtaireachtaí earráide ach i mBéarla: is teachtaireachtaí prótacail iad, dírithe ar fhorbróirí. Ní aistrítear ach an t-ábhar gnó.

Iompraíonn gach freagra aitheantóir iarratais, athráite sa chorp. Luaigh é nuair a dhéanann tú teagmháil linn — tugann sé caol díreach chuig an nglao sinn.

{
  "error": {
    "code": "invalid_request",
    "message": "The request body failed validation.",
    "details": [
      { "path": "items.0.quantity", "message": "expected a string" }
    ],
    "requestId": "2bbb0946-6178-4b54-921c-b28f794c44bd"
  }
}

Stádas	code	Brí
400	invalid_json	Ní JSON bailí é an corp.
422	invalid_request	Tá an JSON bailí ach níl a ábhar. Ainmníonn na sonraí an réimse lochtach.
401	missing_credentials	Ceanntásc Authorization ar iarraidh nó míchumtha.
401	invalid_key	Eochair anaithnid.
401	key_revoked	Eochair cúlghairthe.
403	account_suspended	Tá an cuntas ar leis an eochair curtha ar fionraí.
415	unsupported_media_type	Ní JSON é an cineál ábhair.
413	payload_too_large	Tá corp an iarratais rómhór.
429	rate_limit_exceeded	Cuóta laethúil sroichte. Féach ar an gceanntásc Retry-After.
500	internal_error	Earráid ar ár dtaobh. Bain triail eile as, ansin tuairiscigh dúinn í leis an aitheantóir iarratais.

Sonraí agus coinneáil

Is sonraí do chustaiméirí iad na comhaid a sheoltar tríd an API: coinnímid a laghad agus is féidir, agus tá lasc agat gan aon rud a choinneáil.

Seol „store“ mar false agus ní scríobhfar aon ábhar comhaid: ní fhanann ach an scór agus na cóid mhíchruinnis.
Seachas sin, scriostar ábhar na gcomhad tar éis 30 lá.
Nuair a chúlghairtear eochair scriostar láithreach ábhar na gcomhad a cuireadh isteach léi.
Tarlaíonn an phróiseáil i bhFrankfurt agus tá an bunachar sonraí óstáilte san Aontas Eorpach.
Ní uaslódáiltear aon chomhad tríd an API: ní dhéanann tú ach a dhearbhú cé na doiciméid atá agat.

200 items · 256 KB · 25 / batch · reference ≤ 64

Cad nach bhfuil san API seo

Cuidíonn an tseiceáil leis an ullmhúchán. Ní bailíochtú ó riarachán na gcustam é, ní chuireann sé aon rud isteach, agus ní chuireann sé in ionad na n-oibleagáidí rialála a bhaineann le do idirbheart.

Seiceáiltear cóid chustaim ó thaobh formáide agus comhsheasmhachta leis an idirbheart, ní i gcoinne bunachair taraife riamh: fanann cód dea-chumtha ina chód atá le fíorú.