Zhvilluesit

POST/v3/update_document/{uuid}

Përditësimi i një profili regjistrimi

Dërgoni të gjitha të dhënat e redaktueshme të profilit dhe trajtoni formatin e vjetër të përgjigjes së suksesit.

Në këtë faqe
  1. Zëvendësimi i të dhënave të redaktueshme të një profili
  2. Kërkesa për përditësim
  3. Cilësime të avancuara: shtoni dokumente dëshmuese të ngarkuara më parë
  4. Përgjigjet e suksesit dhe të dështimit në formatin e vjetër
  5. Kufizimet aktuale të përditësimit dhe rikuperimi

Zëvendësimi i të dhënave të redaktueshme të një profili

Përditësoni një profil ekzistues regjistrimi që i përket llogarisë, duke përdorur UUID-në e tij lokale nga create_document ose documents. Ky veprim ndryshon të dhënat e llogarisë dhe të dhënat në sistemin e operatorit në rrjedhën e sipërme. Ai nuk ndryshon llojin e ruajtur të identitetit Personal/Business dhe nuk është një veprim PATCH për përditësimin e pjesshëm të fushave.

Kërkesa për përditësim

Autentikohuni me llogarinë tuaj të aktivizuar të API-së MultiTEL nga një adresë IP e lejuar. Shembujt përdorin kredenciale në ndryshoret e mjedisit dhe të dhëna të trilluara. Lexoni fushat JSON status.code dhe status.msg, si edhe përgjigjen HTTP.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @registration-profile-update.json \
  "https://api.multitel.net/v3/update_document/$DOCUMENT_UUID"
{
  "first_name": "Example",
  "last_name": "Person",
  "phone_number": "12025550123",
  "email": "end-user@example.com",
  "city": "Example City",
  "postal_code": "00000",
  "address": "1 Example Street",
  "country": "US",
  "nationality": "US",
  "signature": "BASE64_PNG_OF_THE_AUTHORIZED_END_USER_SIGNATURE",
  "id_number": "",
  "personal_tax_id": "",
  "birth_date": "",
  "description": "Example profile",
  "company_name": "",
  "company_reg_number": "",
  "incorporation_country": "",
  "vat_id": "",
  "address_description": ""
}

Shembulli paraqet një profil Personal; zëvendësojeni me të gjitha të dhënat e synuara të përdoruesit fundor dhe me nënshkrimin e tij të autorizuar. Mos dërgoni nënshkrime të përkohshme ose vlera bosh si mënyrë për të ruajtur të dhënat. Mbështeten të dhënat hyrëse në format JSON dhe të koduara si formular.

Kërkesat për fushat e përditësimit
FushatSjellja
first_name, last_name, city, postal_code, addressTë detyrueshme; secila mund të ketë deri në 64 karaktere.
phone_numberVlerë numerike e detyrueshme me të paktën tetë karaktere; përdorni shifra në format ndërkombëtar, duke përfshirë kodin e shtetit.
signatureE detyrueshme. Portali jep bajtet PNG të koduara në Base64, pa parashtesën e URL-së së të dhënave.
countryJepni një kod ISO për shtetin e adresës nga katalogu i regjistrimit. Komponenti përpunues identifikon shtetin përkatës, megjithëse përditësimi i adresës në kodin e shqyrtuar nuk ndryshon lidhjen me shtetin.
nationalityKod ISO shteti i detyrueshëm për një profil ekzistues Personal.
company_name, incorporation_countryTë detyrueshme për një profil ekzistues Business; emri i kompanisë mund të ketë deri në 64 karaktere dhe shteti i themelimit duhet të jepet me një kod ISO.
emailAdresë email-i e vlefshme, opsionale, me deri në 254 karaktere. Mos e përfshini fushën për të ruajtur adresën e kontaktit të ruajtur; dërgoni një vlerë bosh për ta fshirë atë lokalisht.
id_number, personal_tax_id, birth_date, description, company_reg_number, vat_idDërgoni vlerat aktuale të synuara. Vlerat e papërfshira marrin si parazgjedhje vlera bosh dhe mund të mbishkruajnë vlerat ekzistuese të ruajtura.

Rregullat e regjistrimit specifike për shtetin mund të kërkojnë informacion ose formate shtesë. Mos rindërtoni një përditësim të plotë duke përdorur get_document si burim të vetëm: përgjigjja e tij e kufizuar nuk përfshin përzgjedhësit e shtetit, email dhe identifikuesit e entiteteve. Ruani të dhënat tuaja burimore të autorizuara ose përdorni redaktuesin e dokumenteve të portalit.

Cilësime të avancuara: shtoni dokumente dëshmuese të ngarkuara më parë

Vargjet opsionale identity_encryptfiles dhe address_encryptfiles pranojnë referenca aktive që i përkasin llogarisë, të marra nga create_encrypt_files. Përdorni kategorinë e entitetit që përputhet me atë të ngarkimit dhe dërgojeni kërkesën përpara skadimit të referencës. Çdo skedar bashkëngjitet në një kërkesë të veçantë për dokument dëshmues, edhe nëse disa skedarë kanë të njëjtin lloj dokumenti dëshmues. Për një dëshmi identiteti me disa skedarë, përdorni më pas rrjedhën e punës për bashkëngjitjen e dokumenteve dëshmuese me një varg të vetëm.

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.

Përgjigjet e suksesit dhe të dështimit në formatin e vjetër

{
  "status": {
    "code": "success",
    "msg": "Successfully Saved."
  },
  "response": ""
}

Kodi i zakonshëm i suksesit i kësaj pike fundore është vargu tekstual success, në vend të vlerës numerike 200. Një dështim i zakonshëm në sistemin e sipërm ose në sistemin lokal mund të përdorë vargun tekstual error. Kodi numerik 400 mbulon fushat e pavlefshme ose dështimet e dokumenteve dëshmuese, 404 një profil që mungon ose një referencë të pavlefshme të skedarit të ngarkuar dhe 500 një trup kërkese bosh ose një shtet që nuk u identifikua. Lexoni mesazhin dhe çdo hollësi të validimit; mos e trajtoni vetëm kodin HTTP 200 si sukses.

Kufizimet aktuale të përditësimit dhe rikuperimi

Një sukses i raportuar nuk garanton se çdo fushë në sistemin e sipërm është ndryshuar. Kodi i shqyrtuar mund ta ruajë profilin lokal pasi përditësimi i adresës në sistemin e sipërm dështon. Përditësimi i identitetit në sistemin e sipërm nuk përfshin email. Kjo rrugë përpunimi nuk konfirmon ndryshimet e shtetit të adresës dhe sinkronizimin e përshkrimit të adresës. Nëse ju duhen këto ndryshime, shqyrtoni rezultatin në portal dhe kontaktoni mbështetjen, në vend që të supozoni se regjistrimi në sistemin e sipërm është përditësuar.

Përditësimi nuk është një transaksion i vetëm atomik: ndryshimet e identitetit dhe bashkëngjitjet e dokumenteve dëshmuese mund të ndodhin përpara një dështimi të mëvonshëm. Nuk vihet në dispozicion asnjë çelës idempotence. Pas një përgjigjeje të paqartë, kontrolloni profilin dhe bashkëngjitjet përpara se të provoni përsëri; dërgimet e përsëritura të dokumenteve dëshmuese mund të krijojnë dublikatë. Përditësimi i një profili nuk nënkupton miratimin e dokumenteve dëshmuese dhe nuk aktivizon një numër.