Bashkëngjitni një dokument mbështetës

Bashkëngjitni një dokument mbështetës të bazuar në një shabllon

Përdorni një shabllon nga get_supporting_document_templates dhe një identitet që tashmë i përket llogarisë suaj. Ngarkoni skedarët e dokumentit përmes create_encrypt_files duke përdorur supporting_template_id. Skedarët e zakonshëm të ngarkuar për të vërtetuar identitetin ose adresën i përkasin një kategorie tjetër dhe nuk mund të përdoren në vend të tyre.

Krijoni dokumentin mbështetës

Përdorni një llogari të aktivizuar MultiTEL API dhe adresën IP të lejuar për të. Shembujt përdorin kredenciale HTTP Basic nga variablat e mjedisit; ndiqni rregullat e autentikimit për llojin e llogarisë suaj. Dërgoni kërkesat përmes HTTPS. Kontrolloni si përgjigjen HTTP, ashtu edhe fushën në objektin JSON status.code; gabimet e aplikacionit mund të kthehen me HTTP 200. Shembujt më poshtë janë të trilluar.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

Fushat e kërkesës
Fusha	Kuptimi
`identity_id`	Identifikuesi i detyrueshëm i identitetit të lidhur me llogarinë suaj. Kjo kërkesë e bashkëngjit dokumentin me një identitet, jo drejtpërdrejt me një adresë ose numër telefoni.
`template_id`	Identifikuesi i detyrueshëm i shabllonit të dokumentit mbështetës; përdorni të njëjtin shabllon të përzgjedhur për ngarkimin e skedarëve mbështetës. Fusha e bashkëngjitjes është template_id, ndërsa fusha e ngarkimit është supporting_template_id.
`encrypted_file_ids`	Varg i detyrueshëm dhe jo bosh JSON me identifikuesit e kthyer për skedarët e ngarkuar. Secili duhet t'i përkasë llogarisë aktuale, të mos ketë skaduar dhe të jetë në kategorinë supporting_documents.

Pranohen gjithashtu të dhëna formulari me fusha të përsëritura encrypted_file_ids[]. Mos dërgoni bajtet e skedarëve te kjo pikë fundore e bashkëngjitjes.

Dokumenti mbështetës i krijuar

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

Kjo konfirmon krijimin e dokumentit mbështetës, jo miratimin nga autoritetet rregullatore apo aktivizimin e numrit. Termi «i përhershëm» në burimin e sistemit të sipërm nuk përbën garanci për klientin lidhur me kohëzgjatjen e ruajtjes ose politikën e fshirjes.

Gabimet dhe riprovimet

Kodi API 500 tregon të dhëna hyrëse që mungojnë, gabime të operatorit të telekomunikacionit ose një përgjigje të pavlefshme prej tij. Kodi 404 tregon një identitet që nuk është i lidhur me llogarinë, një shabllon të pavlefshëm, skedarë të ngarkuar që mungojnë, kanë skaduar ose janë të kategorisë së gabuar, apo një bashkësi bosh skedarësh të përdorshëm. Kontrolloni status.msg; vetëm HTTP 200 nuk mjafton.

Ngarkoni dhe bashkëngjitni skedarët brenda periudhës së vlefshmërisë së referencës së kthyer të skedarit. Pas një përgjigjeje me rezultat të pasigurt, kontrolloni dokumentet mbështetëse të identitetit në portal përpara se të riprovoni. Ky funksion që trajton kërkesën nuk vë në dispozicion asnjë çelës idempotence.