Priložite popratni dokument

Priložite popratni dokument temeljen na predlošku

Upotrijebite predložak iz get_supporting_document_templates i identitet koji već pripada vašem računu. Učitajte datoteke dokumenta putem create_encrypt_files uz upotrebu supporting_template_id. Uobičajene učitane datoteke za dokazivanje identiteta ili adrese pripadaju drugoj kategoriji i ne mogu se upotrijebiti kao zamjena.

Izradite popratni dokument

Upotrijebite omogućen račun za MultiTEL API i njegovu dopuštenu IP adresu. Primjeri koriste vjerodajnice za HTTP Basic iz varijabli okruženja; slijedite pravila autentifikacije za svoju vrstu računa. Šaljite zahtjeve putem protokola HTTPS. Provjerite i odgovor protokola HTTP i sljedeće polje u odgovoru u formatu JSON: status.code; aplikacijske pogreške mogu se vratiti uz HTTP 200. Primjeri u nastavku su izmišljeni.

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"
  ]
}

Polja zahtjeva
Polje	Značenje
`identity_id`	Obavezan identifikator identiteta povezanog s vašim računom. Ovim se zahtjevom dokument prilaže identitetu, a ne izravno adresi ili telefonskom broju.
`template_id`	Obavezan identifikator predloška popratnog dokumenta; upotrijebite isti odabrani predložak kao pri učitavanju popratnog dokumenta. Polje za prilaganje je template_id, a polje za učitavanje je supporting_template_id.
`encrypted_file_ids`	Obavezan neprazan niz u formatu JSON s vraćenim identifikatorima učitanih datoteka. Svaka učitana datoteka mora pripadati trenutačnom računu, ne smije biti istekla i mora pripadati kategoriji supporting_documents.

Prihvaćaju se i podaci obrasca s ponovljenim poljima encrypted_file_ids[]. Nemojte slati bajtove datoteka ovoj krajnjoj točki za prilaganje.

Izrađeni popratni dokument

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

Time se potvrđuje izrada popratnog dokumenta, a ne regulatorno odobrenje ili aktivacija broja. Izraz trajno u resursu nadređenog sustava nije jamstvo korisniku o trajanju pohrane ili pravilima brisanja.

Pogreške i ponovni pokušaji

Kod API-ja 500 označava nedostajuće ulazne podatke, pogreške telekomunikacijskog operatora ili nevaljan odgovor operatora. Kod 404 označava identitet koji nije povezan s računom, nevaljan predložak, učitane datoteke koje nedostaju, kojima je istekla valjanost ili pripadaju pogrešnoj kategoriji, ili prazan skup upotrebljivih datoteka. Provjerite status.msg; sam HTTP 200 nije dovoljan.

Učitajte i priložite datoteke unutar roka valjanosti vraćene reference na datoteku. Ako odgovor nije jasan, prije ponovnog pokušaja provjerite popratne dokumente identiteta na portalu. Ova funkcija za obradu zahtjeva ne stavlja na raspolaganje ključ idempotentnosti.