Izstrādātājiem

POST/v3/get_requirements

Iepazīstieties ar reģistrācijas prasībām

Iegūstiet reģistrācijas prasības, kas pašlaik tiek atgrieztas norādītajai valstij un numura tipa nosaukumam.

Šajā lapā
  1. Izvēlieties valsti un numura tipu
  2. Izlasiet atgrieztos norādījumus
  3. Neuzskatiet kļūdu par atbrīvojumu no reģistrācijas prasībām
  4. Pieprasījums
  5. Atbilde
  6. Kļūdas
  7. Pieejamība un blakusefekti

Izvēlieties valsti un numura tipu

Izvēlieties reģistrācijas valsti un pēc tam izmantojiet nosaukumu, ko atgriež get_document_number_types. Nosūtiet šo nosaukumu kā number_type, nevis tipa ID vai vispārīgu numuru meklēšanas kategoriju.

Izlasiet atgrieztos norādījumus

Saglabājiet prasības un saistību ID attiecīgajai identitātes vai dokumentu darbplūsmai. Šis izsaukums atgriež prasības; tas nepārbauda un neiesniedz jūsu failus. Ievērojiet atgrieztos norādījumus un visas prasības, kas attiecas tieši uz izvēlēto numuru.

Neuzskatiet kļūdu par atbrīvojumu no reģistrācijas prasībām

Kļūdas paziņojums par nederīgu valsti vai par to, ka valstī nav nepieciešami reģistrācijas dokumenti, apvieno divus nosacījumus. Tas nepierāda, ka reģistrācija nav nepieciešama. Arī neveiksmīga meklēšana vai tukšs rezultāts nenozīmē klienta vai numura apstiprināšanu. Ja rezultāts nav skaidrs, sazinieties ar atbalsta dienestu.

Pieprasījums

Izmantojiet sava iespējotā API konta piekļuves datus, savienojumam lietojot HTTPS. Tiek atbalstīta pamatautentifikācija un iespējoti API konta uzrādītāja pilnvarojuma marķieri; ir spēkā konta ierobežojumi.

POST ar application/json vai 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"
Pieprasījuma pamatdaļas parametri
NosaukumsTipsObligātsApraksts
countryvirkneJāValsts ISO kods, ko atgriež get_document_countries.
number_typevirkneJāTipa nosaukums, ko atgriež get_document_number_types, piemēram, Local; salīdzinot netiek ņemts vērā burtu reģistrs. Norādiet nosaukumu, nevis tā ID.

Atbilde

Pārbaudiet gan status.code JSON pamatdaļā, gan HTTP statusu. response ir viens prasību resurss ar laukiem id, type un attributes, kā arī relationships, ja šis lauks tiek atgriezts. Resursa un saistību datos ietvertajiem ID nav interpretējamas iekšējas nozīmes. No neobligātā restriction_message teksta ir noņemtas HTML atzīmes; atlikušo tekstu apstrādājiet kā tekstu, nevis uzticamu HTML. Apstrādātājs atgriež pirmo prasību resursu, tāpēc neuzskatiet šo atbildi par pilnīgu sarakstu. Atribūtu un saistību pieejamība ir atkarīga no valsts un tipa; piemērs nav pilnīga, nemainīga shēma.

Ilustratīvs atbildes struktūras piemērs; tie nav faktiskie konta dati vai aktuāls cenas piedāvājums.

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

Kļūdas

  • 400: Valsts un number_type validācija neizdevās: norādiet abas obligātās vērtības. Validācijas paziņojuma tekstā var būt formatējums.
  • 400: Invalid country ISO or No country registration documents required.: šis neviennozīmīgais paziņojums pats par sevi nepierāda atbrīvojumu no reģistrācijas prasībām.
  • 400: Invalid number type: izmantojiet atgrieztu tipa nosaukumu. Vecajā kļūdas paziņojumā ir uzskaitīti Global, Local, Mobile, National, Shared Cost un Toll Free.
  • 500: Unable to load registration requirements for the specified country and number type.: prasības neizdevās veiksmīgi atgriezt. Mēģiniet vēlreiz vēlāk vai sazinieties ar atbalsta dienestu.

Pieejamība un blakusefekti

  • Šī meklēšana katalogā vai prasību izgūšana neveido identitātes ierakstu, neaugšupielādē apliecinošu dokumentu, nereģistrē numuru un neveic pasūtījumu.
  • Veiksmīga kataloga atbilde nenozīmē jūsu dokumentu apstiprināšanu un neapliecina, ka izvēlēto numuru var aktivizēt.