Krijoni profilin vetëm një herë
Kjo kërkesë krijon një profil lokal regjistrimi së bashku me regjistrimet e identitetit dhe të adresës te operatori. Filloni me informacionin aktual për vendet e regjistrimit, llojet e numrave dhe kërkesat. Kërkesat varen nga vendi dhe lloji i numrit që planifikoni të regjistroni.
Një përgjigje e suksesshme e krijimit nuk është miratim rregullator dhe as aktivizim i numrit. Ruani veçmas UUID-në e dokumentit, ID-në e identitetit dhe ID-në e adresës: ato shërbejnë për qëllime të ndryshme. Kjo kërkesë ndryshon të dhënat e llogarisë dhe nuk është një veprim vetëm për validim.
Kërkesa e krijimit
Autentikohuni me llogarinë tuaj të aktivizuar MultiTEL API dhe me adresën IP të lejuar të saj. Shembujt përdorin kredenciale HTTP Basic të ruajtura në variabla mjedisi. Kontrolloni si përgjigjen HTTP, ashtu edhe fushën JSON status.code; një përgjigje HTTP 200 më vete nuk vërteton suksesin. Të gjitha vlerat e shembujve janë fiktive.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header 'Content-Type: application/json' \
--data @registration-profile.json \
https://api.multitel.net/v3/create_document{
"identity_type": "Personal",
"first_name": "Example",
"last_name": "Person",
"phone_number": "12025550123",
"email": "end-user@example.com",
"city": "Example City",
"postal_code": "00000",
"country": "US",
"address": "1 Example Street",
"nationality": "US",
"signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE"
}JSON-i është një profil ilustrues Personal, jo një identitet real gati për dorëzim. Zëvendësoni detajet dhe nënshkrimin e tij me informacionin e përdoruesit fundor që kërkohet nga rregullat e zgjedhura të regjistrimit. Mbështetet edhe hyrja e koduar si formular.
| Fusha | Detyrueshmëria dhe formati |
|---|---|
identity_type | E detyrueshme. Përdorni saktësisht vlerën Personal ose Business; validimi i kushtëzuar varet nga shkronjat e mëdha. |
first_name, last_name | Të detyrueshme, secila me jo më shumë se 64 karaktere. Për një biznes, jepni të dhënat e përfaqësuesit që kërkohen nga vendi i zgjedhur. |
phone_number | Vlerë numerike telefoni e detyrueshme, me të paktën tetë karaktere. Një numër ndërkombëtar vetëm me shifra, duke përfshirë kodin e vendit, është i përshtatshëm për këtë validim; ky është një numër kontakti, jo një blerje numri. |
city, postal_code, address | Të detyrueshme, secila me jo më shumë se 64 karaktere. |
country | Kod ISO i detyrueshëm i vendit të adresës nga katalogu i regjistrimit. Shërbimi e përkthen atë në regjistrimin e vendit te operatori. |
signature | Të dhëna nënshkrimi të detyrueshme. Portali aktual jep bajtet e imazhit PNG në Base64 pa prefiksin data:image/png;base64,. Merrni nënshkrimin e përdoruesit fundor përmes rrjedhës suaj të autorizuar të punës; një vendmbajtës jo bosh nuk është nënshkrim i vlefshëm. |
nationality | E detyrueshme për Personal, si kod ISO vendi. Mos e zëvendësoni me një UUID vendi. |
company_name, incorporation_country | Të detyrueshme për Business. Emri i kompanisë ka jo më shumë se 64 karaktere; incorporation_country është një kod ISO vendi. |
email | E-mail kontakti opsional i përdoruesit fundor, me jo më shumë se 254 karaktere. Një e-mail i hequr ose i lënë bosh nuk trashëgon e-mailin e llogarisë bazë. |
company_reg_number, vat_id, id_number, personal_tax_id, birth_date, description | Opsionale në këtë handler, por vendi/operatori i zgjedhur mund të kërkojë disa prej tyre. Jepni formatet e kërkuara për atë regjistrim. Thirrjet e drejtpërdrejta API nuk zbatojnë automatikisht çdo normalizim që kryen portali. |
Ky handler i drejtpërdrejtë v3 kërkon fushat e adresës dhe krijon një adresë. Mos supozoni se opsioni i portalit për shtyrjen e adresës është i disponueshëm përmes tij.
Ruani të tre identifikuesit
Më poshtë paraqiten fusha të zgjedhura të përgjigjes; përgjigja reale përmban gjithashtu informacionin e dorëzuar të profilit dhe të dhënat e nënshkrimit. Trajtojeni përgjigjen e plotë si private.
{
"status": {
"code": 200,
"msg": "Success Create Registration Detail."
},
"response": {
"uuid": "11111111111111111111111111111111",
"identity_id": "22222222222222222222222222222222",
"address_id": "33333333333333333333333333333333",
"country_iso": "US",
"email": "end-user@example.com"
}
}response.uuididentifikon profilin lokal. Përdoreni atë me get_document. Në përgjigjet e documents dhe get_document, i njëjti identifikues profili quhetid.response.identity_ididentifikon identitetin për dorëzimin e mëvonshëm të provave të identitetit dhe dokumenteve mbështetëse.response.address_ididentifikon adresën e krijuar. Ruajeni veçmas; UUID-ja e profilit lokal nuk është ID adrese. Përputhshmëria e bashkëngjitjes së mëvonshme të provave të adresës për profilet e sapokrijuara është ende në shqyrtim.
Dy pikat fundore të leximit të profilit nuk kthejnë identity_id ose address_id, prandaj ruani përgjigjen origjinale të krijimit të suksesshëm. Nëse ka humbur, përdorni pamjen e dokumentit në portal ose kontaktoni mbështetjen përpara se të krijoni një zëvendësim.
E avancuar: bashkëngjitja e provave të ngarkuara paraprakisht gjatë krijimit
Mund të jepni identity_encryptfiles dhe address_encryptfiles si vargje ID-sh të kthyera nga create_encrypt_files. Ngarkoni duke përdorur një lloj prove për kategorinë përkatëse të entitetit, pastaj dorëzoni përpara skadimit të referencës së skedarit, që është afërsisht 20 minuta. Handler-i i krijimit kontrollon llogarinë, kategorinë dhe skadimin e secilës referencë të dhënë.
Këto fusha kanë emra të ndryshëm nga encrypted_file_ids e pikës fundore të mëvonshme të bashkëngjitjes. Gjatë krijimit, çdo skedar dërgohet si kërkesë prove më vete, edhe kur disa skedarë ndajnë të njëjtin lloj prove. Për një provë identiteti që duhet të përmbajë disa skedarë së bashku, përdorni kërkesën e mëvonshme create_proof me një varg të vetëm. Krijimi i suksesshëm i profilit më vete nuk jep rezultate individuale të miratimit të provave.
Nëse një provë e mëvonshme adrese refuzohet për një adresë të sapokrijuar, mos e zëvendësoni me UUID-në e profilit dhe mos e rikrijoni identitetin në mënyrë të përsëritur. Ndaloni dhe kontrolloni profilin në portal ose me mbështetjen. Rruga e leximit/kërkimit të provave të adresës mbetet një kufizim i shqyrtimit.
Dështimet dhe krijimi i pjesshëm
Kodi API 400 mbulon validimin e fushave, dështimet e krijimit te operatori dhe dështimet e ruajtjes lokale. Gabimet e validimit mund të shfaqen si zëra të indeksuar sipas fushës në response. Kodi 500 përdoret për një vend regjistrimi të padisponueshëm/të pavlefshëm, dhe kodi 404 për referenca të ngarkuara paraprakisht që mungojnë ose kanë skaduar. Lexoni status.msg së bashku me kodin.
Profili lokal dhe veprimet te operatori në rrjedhën e sipërme nuk janë një transaksion i vetëm atomik. Një kërkesë e dështuar mund të lërë gjendje në rrjedhën e sipërme edhe kur nuk listohet asnjë profil lokal. Nuk ekspozohet asnjë çelës idempotence për klientin. Pas një skadimi kohe ose dështimi të pasigurt, inspektoni profilet ekzistuese dhe kontaktoni mbështetjen përpara se ta përsërisni krijimin; një listë documents bosh nuk është provë se asgjë nuk u krijua në rrjedhën e sipërme.