Kūrėjams

POST/v3/directory/{number}

Pateikite telefono numerio įrašą katalogui

Pateikite kliento patvirtintą įrašą operatoriaus katalogui, susipažinkite su taikomu mokesčiu ir prieš kartodami užklausą išsiaiškinkite neaiškius rezultatus.

Šiame puslapyje
  1. Pateikite įrašą operatoriaus katalogui
  2. Paskyros ir numerio reikalavimai
  3. Formos POST užklausa
  4. Apmokestinimas ir pakartotinių užklausų vykdymas
  5. Atsakymas
  6. Senosios sistemos klaidos
  7. Prieš kartodami patikrinkite

Pateikite įrašą operatoriaus katalogui

Pateikite vardą arba pavadinimą ir adresą, kurie bus naudojami katalogo įraše, skirtame jums priklausančiam ir reikalavimus atitinkančiam „MultiTEL“ telefono numeriui. Tai mokamas atnaujinimas operatoriaus sistemoje, o ne skambinančiojo vardo paieška, įrašas privačioje adresų knygoje ar bendras portalo numerių sąrašo lauko LIDB atnaujinimas.

Pateikite tik tuos duomenis, kuriuos klientas leido naudoti katalogo įraše. Prieš naudodami šį senosios sistemos maršrutą įsitikinkite, kad operatorius palaiko šią paslaugą tam numeriui. Peržiūrėta apdorojimo programa netikrina, ar paslaugų teikėjas atitinka reikalavimus, ir netikrina tarptautinio numerio formato; formuojant užklausą operatoriui daroma prielaida, kad tai Šiaurės Amerikos numeris, ir pašalinamas pirmasis išsaugotas skaitmuo.

Paskyros ir numerio reikalavimai

Naudokite įgalintą API paskyrą ir junkitės per HTTPS iš leidžiamo šaltinio IP adreso. Tikslus numeris turi būti neatšauktas tai paskyrai priklausantis įsigyto numerio įrašas. Naudokite visus savo numerių sąraše esančio tarptautinio numerio skaitmenis, pavyzdžiui, palaikomam Šiaurės Amerikos numeriui taikomą formatą su šalies kodu 1. Nenaudokite kainodaros plano identifikatoriaus, numerio UUID ar kitai paskyrai priklausančio numerio.

Formos POST užklausa

Nustatykite NUMBER reikšmę į jums priklausantį numerį. Išgalvotus pavyzdžio duomenis pakeiskite patvirtinta katalogo įrašo informacija. Šis maršrutas nuskaito formos laukus iš POST užklausos; jis neanalizuoja application/json formato užklausos turinio.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode "lastname=EXAMPLE" \
  --data-urlencode "firstname=EXAMPLE" \
  --data-urlencode "streetnum=1" \
  --data-urlencode "streetname=Example" \
  --data-urlencode "streetpredir=N" \
  --data-urlencode "streetpostdir=W" \
  --data-urlencode "city=Example City" \
  --data-urlencode "state=NY" \
  --data-urlencode "postalcode=10001" \
  "https://api.multitel.net/v3/directory/$NUMBER"
Katalogo įrašo formos laukai
LaukasPrivalomas šioje APIReikšmė
lastnameTaipĮraše naudojama pavardė arba atitinkamas įrašo pavadinimo laukas.
cityTaipĮraše nurodomas miestas.
postalcodeTaipĮraše nurodomas pašto kodas.
stateTaipĮraše nurodoma valstija arba regionas, kurį priima palaikomas operatorius.
streetnameTaipGatvės pavadinimas.
streetnumTaipNamo numeris.
firstnameNePapildoma vardo dalis.
streetpredir, streetpostdirNeKrypties žymenys prieš gatvės pavadinimą ir po jo, kai taikoma.
streettype, locationNeGatvės tipo žymuo arba papildomas vietos aprašymas, kai taikoma.

Pavyzdyje pateikti krypties žymenys ir adresas yra tik pavyzdiniai duomenys, o ne rekomenduojamas pašto adresas. Nepridėkite išgalvoto krypties žymens prie tikrų kliento duomenų. API privalomų laukų patikros yra paviršutiniškos: jos nepatvirtina, kad adresas yra galiojantis ar kad jį priima operatorius, o senojoje svetainėje formai buvo taikomi kitokie reikalavimai.

Jei neprivalomo krypties žymens nėra arba jis tuščias, dabartinė realizacija gali pateikti įspėjimą apie trūkstamą masyvo raktą. Jei atsakymo formatas netaisyklingas arba operatorius atmeta adresą, išsaugokite užklausos nuorodą ir paprašykite pagalbos tarnybos patvirtinti įrašą, užuot pakartotinai teikę spėjamus pakeistus adreso variantus.

Apmokestinimas ir pakartotinių užklausų vykdymas

Peržiūrėta apdorojimo programa patikrina, ar likutis yra bent 10.00 likučio vienetų prieš kreipdamasi į operatorių. Operatoriui pranešus apie sėkmę ir vietiniam numerio atnaujinimui taip pat pranešus apie sėkmę, ji nuskaičiuoja 10.00 nuo paskyros likučio ir įrašo katalogo įrašo sukūrimo operaciją. Tai šiuo metu realizacijoje nustatytos sumos, o ne naujas kainodaros pasiūlymas; prieš pateikdami užklausą pagal savo paskyros sąlygas pasitikrinkite taikomą atsiskaitymo valiutą ir palaikomą paslaugą.

Ši operacija neturi idempotentiškumo rakto, apsaugos nuo pasikartojančių užsakymų ar bendros transakcijos, apimančios pateikimą operatoriui, vietinį atnaujinimą ir apmokestinimą. Sėkminga pakartotinė užklausa gali lemti dar vieną pateikimą operatoriui ir dar vieną mokestį. Pasibaigęs laukimo laikas ar API klaida neįrodo, kad operatorius atmetė ankstesnę užklausą: paslaugų teikėjas galėjo ją priimti prieš įvykstant vietinio atnaujinimo klaidai.

Atsakymas

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": ""
}

Įprastame sėkmės atsakyme tuščia eilute pateikiamas laukas response ir negrąžinamas nei katalogo įrašo identifikatorius, nei užbaigimo informacija. Tai reiškia, kad operatoriaus užklausos ir vietinio atnaujinimo vykdymo sekos pranešė apie sėkmę; tai neįrodo paskelbimo visuose išoriniuose kataloguose, momentinio duomenų išplitimo ar būsimo skambinančiojo identifikacijos rodymo.

Senosios sistemos klaidos

Katalogo įrašų API rezultatų kodai
API kodasReikšmė
404Numeris paskyroje nerastas arba vienas iš privalomų formos laukų buvo tuščias.
400Paskyros likutis mažesnis už realizacijoje nustatytą mokestį.
500Užklausa operatoriui nepavyko arba vietinis atnaujinimas nepavyko po to, kai operatorius jau galėjo būti priėmęs užklausą.
200Pranešta apie sėkmę; atsakyme nėra paskelbimo patvirtinimo.

Tikrinkite ir HTTP būseną, ir JSON laukus status.code/status.msg. Autentifikavimo ir šaltinio IP adreso apribojimai taip pat gali sutrukdyti gauti tinkamą naudoti atsakymą. Nenaudokite GET metodo ar užklausos eilutės parametrų atnaujinimui prašyti vien dėl to, kad senosios sistemos apdorojimo programoje nėra aiškios HTTP metodo patikros.

Prieš kartodami patikrinkite

  1. Prieš siųsdami užklausą patikrinkite, ar numeris jums priklauso, ar operatorius atitinka reikalavimus, ar katalogo įrašo duomenys patvirtinti ir koks bus mokestis.
  2. Pateikite užklausą vieną kartą ir išsaugokite paskyros pusėje gautą rezultatą, neatskleisdami kliento adreso viešuose žurnaluose ar analitikos sistemose.
  3. Patikrinkite išsaugotą įrašą ir operacijų istoriją naudodami palaikomą paskyros darbo eigą arba kreipdamiesi į pagalbos tarnybą. Palaukite operatoriaus patvirtintą apdorojimo laiką; ši API nenustato garantuoto duomenų išplitimo termino.
  4. Jei rezultatas neaiškus, prieš bandydami dar kartą paprašykite pagalbos tarnybos sutikrinti operatoriaus užsakymą ir vietinius apmokestinimo duomenis. Pakartotinė užklausa nėra idempotentiška būsenos patikra.