Zhvilluesit

POST/v3/get_requirements

Lexoni kërkesat e regjistrimit

Merrni kërkesat e regjistrimit që kthehen aktualisht për një shtet dhe një emërtim të llojit të numrit.

Në këtë faqe
  1. Zgjidhni shtetin dhe llojin e numrit
  2. Lexoni udhëzimet e kthyera
  3. Mos e interpretoni një gabim si përjashtim nga detyrimi
  4. Kërkesa
  5. Përgjigjja
  6. Gabimet
  7. Disponueshmëria dhe efektet anësore

Zgjidhni shtetin dhe llojin e numrit

Zgjidhni shtetin e regjistrimit, pastaj përdorni një emërtim të kthyer nga get_document_number_types. Dërgojeni atë emërtim si number_type, jo një ID të llojit apo një kategori të përgjithshme për kërkimin e numrave.

Lexoni udhëzimet e kthyera

Ruani ID-të e kërkesave dhe të marrëdhënieve për rrjedhën përkatëse të punës me identitetin ose dokumentet. Kjo thirrje kthen kërkesa; ajo nuk i vërteton dhe nuk i dorëzon skedarët tuaj. Ndiqni udhëzimet e kthyera dhe çdo kërkesë specifike për numrin e zgjedhur.

Mos e interpretoni një gabim si përjashtim nga detyrimi

Gabimi që lidhet me një shtet të pavlefshëm ose me mungesën e dokumenteve të kërkuara për regjistrim në atë shtet bashkon dy kushte. Ai nuk është provë se regjistrimi është i panevojshëm. As një kërkim i dështuar dhe as një rezultat bosh nuk përbëjnë miratim të një klienti apo numri. Kontaktoni shërbimin e mbështetjes nëse rezultati është i paqartë.

Kërkesa

Përdorni kredencialet e llogarisë suaj API të aktivizuar përmes HTTPS. Mbështeten autentikimi bazë dhe tokenët e tipit bearer të aktivizuar për llogarinë API; zbatohen kufizimet e llogarisë.

POST me application/json ose application/x-www-form-urlencoded.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"
Parametrat e trupit të kërkesës
EmriLlojiI detyrueshëmPërshkrimi
countryvarg karaktereshPoKodi ISO i shtetit nga get_document_countries.
number_typevarg karaktereshPoEmërtimi i llojit nga get_document_number_types, si për shembull Local; përputhja nuk bën dallim mes shkronjave të mëdha dhe të vogla. Jepni emërtimin, jo ID-në e tij.

Përgjigjja

Kontrolloni status.code në trupin JSON, si edhe statusin HTTP. response është një burim i vetëm kërkesash me id, type dhe attributes, si edhe relationships kur këto kthehen. ID-të në të dhënat e burimit dhe të marrëdhënieve janë opake. Etiketat HTML hiqen nga teksti opsional restriction_message; trajtojeni tekstin e mbetur si tekst, jo si HTML të besuar. Përpunuesi kthen burimin e parë të kërkesave, prandaj mos nxirrni përfundimin se kjo përgjigje është një listë shteruese. Disponueshmëria e atributeve dhe e marrëdhënieve varet nga shteti dhe lloji; shembulli nuk është një skemë e plotë dhe e pandryshueshme.

Strukturë ilustruese e përgjigjes; nuk përfaqëson të dhëna të llogarisë në kohë reale apo një ofertë çmimi aktuale.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

Gabimet

  • 400: Vërtetimi i shtetit dhe i number_type dështoi: jepni të dyja vlerat e detyrueshme. Teksti i vërtetimit mund të përmbajë formatim.
  • 400: Invalid country ISO or No country registration documents required.: ky mesazh i paqartë nuk provon, në vetvete, një përjashtim nga detyrimi i regjistrimit.
  • 400: Invalid number type: përdorni një emërtim lloji të kthyer. Mesazhi i gabimit nga versioni i mëparshëm rendit Global, Local, Mobile, National, Shared Cost dhe Toll Free.
  • 500: Unable to load registration requirements for the specified country and number type.: kërkesat nuk u kthyen me sukses. Provoni përsëri më vonë ose kontaktoni shërbimin e mbështetjes.

Disponueshmëria dhe efektet anësore

  • Ky kërkim në katalog ose në kërkesa nuk krijon një identitet, nuk ngarkon një dokument dëshmues, nuk regjistron një numër dhe nuk bën një porosi.
  • Një përgjigje e suksesshme nga katalogu nuk përbën miratim të dokumenteve tuaja apo konfirmim se një numër i zgjedhur mund të aktivizohet.