Atașați un document justificativ bazat pe un șablon
Folosiți un șablon din get_supporting_document_templates și o identitate care aparține deja contului dumneavoastră. Încărcați fișierele documentului prin create_encrypt_files folosind supporting_template_id. Fișierele obișnuite încărcate pentru dovedirea identității sau adresei fac parte dintr-o altă categorie și nu pot fi folosite în locul acestora.
Creați documentul justificativ
Folosiți un cont MultiTEL API activat și adresa IP autorizată pentru acesta. Exemplele folosesc date de autentificare HTTP Basic din variabile de mediu; respectați convențiile de autentificare pentru tipul dumneavoastră de cont. Trimiteți cererile prin HTTPS. Verificați atât răspunsul HTTP, cât și câmpul din obiectul JSON status.code; erorile aplicației pot fi returnate cu HTTP 200. Exemplele de mai jos sunt fictive.
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"
]
}| Câmp | Semnificație |
|---|---|
identity_id | Identificatorul obligatoriu al identității asociate contului dumneavoastră. Această cerere atașează documentul unei identități, nu direct unei adrese sau unui număr de telefon. |
template_id | Identificatorul obligatoriu al șablonului pentru documentul justificativ; folosiți același șablon selectat la încărcarea fișierelor justificative. Câmpul pentru atașare este template_id, iar câmpul pentru încărcare este supporting_template_id. |
encrypted_file_ids | O listă JSON obligatorie, nevidă, cu identificatorii returnați pentru fișierele încărcate. Fiecare trebuie să aparțină contului curent, să nu fie expirat și să facă parte din categoria supporting_documents. |
Sunt acceptate și date de formular cu câmpuri repetate encrypted_file_ids[]. Nu trimiteți octeții fișierelor la acest punct de acces pentru atașare.
Document justificativ creat
{
"status": {
"code": 200,
"msg": "Supporting document created successfully."
},
"response": {
"id": "77777777777777777777777777777777",
"template_id": "55555555555555555555555555555555",
"identity_id": "33333333333333333333333333333333",
"template_name": "Example supporting template"
}
}Acest răspuns confirmă crearea documentului justificativ, nu aprobarea din partea autorităților de reglementare sau activarea numărului. Termenul „permanent” din resursa sistemului din amonte nu reprezintă o garanție oferită clientului privind durata stocării sau politica de ștergere.
Erori și reîncercări
Codul API 500 indică date de intrare lipsă, erori ale operatorului de telecomunicații sau un răspuns nevalid al acestuia. Codul 404 indică o identitate care nu este asociată contului, un șablon nevalid, fișiere încărcate care lipsesc, au expirat sau aparțin unei categorii greșite ori un set gol de fișiere utilizabile. Verificați status.msg; doar HTTP 200 nu este suficient.
Încărcați și atașați fișierele în intervalul de valabilitate al referinței la fișier returnate. După un răspuns cu rezultat incert, verificați documentele justificative ale identității în portal înainte de a reîncerca. Această funcție de tratare a cererilor nu pune la dispoziție nicio cheie de idempotență.