Dien ’n gidsinskrywing by die netwerkoperateur in
Dien die naam en adres in wat vir ’n gidsinskrywing gebruik moet word vir ’n kwalifiserende telefoonnommer wat jy in MultiTEL besit. Dit is ’n betaalde opdatering by die netwerkoperateur, nie ’n opsoek van ’n beller se naam, ’n private adresboekinskrywing of ’n algemene opdatering van die portaal se LIDB-voorraadveld nie.
Dien slegs besonderhede in wat die kliënt vir ’n gidsinskrywing gemagtig het. Bevestig dat die netwerkoperateur die nommer ondersteun voordat jy hierdie ou roete gebruik. Die nagegane versoekhanteerder valideer nie die diensverskaffer se geskiktheid of die internasionale nommerformaat nie; sy versoek aan die operateur veronderstel ’n Noord-Amerikaanse nommer en verwyder die eerste gestoorde syfer.
Vereistes vir die rekening en nommer
Gebruik ’n geaktiveerde API-rekening oor HTTPS vanaf ’n toegelate bron-IP-adres. Die presiese nommer moet ’n rekord van ’n gekoopte nommer wees wat aan daardie rekening behoort en nie nietig verklaar is nie. Gebruik die volledige internasionale syfers in jou voorraad, soos die formaat met landkode 1 vir ’n ondersteunde Noord-Amerikaanse nommer. Moenie ’n tariefplan se identifiseerder, ’n nommer se UUID of ’n nommer wat aan ’n ander rekening behoort, gebruik nie.
POST-versoek met vormdata
Stel NUMBER op die nommer wat jy besit. Vervang die fiktiewe voorbeeld met die gemagtigde inligting vir die gidsinskrywing. Hierdie roete lees vormvelde uit POST; dit ontleed nie ’n application/json-versoekliggaam nie.
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"| Veld | Deur hierdie API vereis | Betekenis |
|---|---|---|
| lastname | Ja | Die van vir die gidsinskrywing of die toepaslike veld vir die inskrywingsnaam. |
| city | Ja | Die stad vir die gidsinskrywing. |
| postalcode | Ja | Die poskode vir die gidsinskrywing. |
| state | Ja | Die staat of streek vir die gidsinskrywing wat deur die ondersteunde netwerkoperateur aanvaar word. |
| streetname | Ja | Straatnaam. |
| streetnum | Ja | Straatnommer. |
| firstname | Nee | Bykomende voornaamkomponent. |
| streetpredir, streetpostdir | Nee | Rigtingkomponente voor en ná die straatnaam, waar van toepassing. |
| streettype, location | Nee | Straattipe of bykomende liggingsteks, waar van toepassing. |
Die voorbeeld se rigtings en adres is plekhouers, nie ’n aanbevole posadres nie. Moenie ’n fiktiewe rigting by werklike kliëntdata voeg nie. Die API se kontroles vir verpligte velde is oppervlakkig: hulle stel nie vas of ’n adres geldig is of deur die netwerkoperateur aanvaar word nie, en die ou webwerf het ander vormvereistes toegepas.
Die implementering kan ’n waarskuwing oor ’n ontbrekende skikkingsleutel uitreik wanneer ’n opsionele rigtingkomponent ontbreek of leeg is. As die antwoord verkeerd geformateer is of die netwerkoperateur die adres verwerp, behou die versoekverwysing en vra die ondersteuningsdiens om die gidsinskrywing te bevestig, eerder as om herhaaldelik gewysigde raaiskote oor die adres in te dien.
Heffings en die werking van herhaalde pogings
Die nagegane versoekhanteerder kontroleer of daar minstens 10.00 saldo-eenhede beskikbaar is voordat dit die netwerkoperateur kontak. Nadat die operateur sukses rapporteer en die plaaslike nommeropdatering ook sukses rapporteer, trek dit 10.00 van die rekeningsaldo af en teken ’n transaksie vir die opstel van die gidsinskrywing aan. Dit is die huidige geïmplementeerde bedrae, nie ’n nuwe prysvoorstel nie; bevestig die toepaslike faktureringsgeldeenheid en ondersteunde diens volgens jou rekeningvoorwaardes voordat jy die versoek indien.
Die bewerking het geen idempotensiesleutel, beskerming teen duplikaatbestellings of transaksie wat indiening by die netwerkoperateur, die plaaslike opdatering en fakturering saam omvat nie. ’n Suksesvolle herhaalde versoek kan tot nog ’n indiening by die operateur en nog ’n heffing lei. ’n Uitteltyd of API-fout bewys nie dat die operateur die vroeëre versoek verwerp het nie: die diensverskaffer kon dit aanvaar het voordat ’n plaaslike opdatering misluk het.
Antwoord
{
"status": {
"code": 200,
"msg": "Success"
},
"response": ""
}Die gewone suksesantwoord het ’n leë string as waarde vir response en gee geen identifiseerder vir die gidsinskrywing of voltooiingsbesonderhede terug nie. Dit beteken dat die operateurproses en die plaaslike opdateringsproses sukses gerapporteer het; dit bewys nie publikasie in elke eksterne gids, onmiddellike verspreiding of toekomstige vertoning by belleridentifikasie nie.
Foute van die ou stelsel
| API-kode | Betekenis |
|---|---|
| 404 | Die nommer is nie op die rekening gevind nie, of een van die verpligte vormvelde was leeg. |
| 400 | Die rekeningsaldo is laer as die geïmplementeerde heffing. |
| 500 | Die versoek aan die netwerkoperateur het misluk, of die plaaslike opdatering het misluk nadat die operateur die versoek moontlik reeds aanvaar het. |
| 200 | Sukses is gerapporteer; die antwoord bevat geen bevestiging van publikasie nie. |
Lees sowel die HTTP-status as die JSON-velde status.code/status.msg. Stawing en beperkings op bron-IP-adresse kan ook ’n bruikbare antwoord verhinder. Moenie GET of navraagparameters gebruik om ’n opdatering aan te vra bloot omdat die ou versoekhanteerder geen uitdruklike kontrole van die HTTP-metode het nie.
Verifieer voordat jy weer probeer
- Bevestig die nommer wat jy besit, die geskiktheid vir die netwerkoperateur, die gemagtigde inskrywingsdata en die heffing voordat jy die versoek stuur.
- Dien een keer in en behou die resultaat aan die rekening se kant sonder om die kliënt se adres in openbare logboeke of ontledingsdata bloot te lê.
- Gaan die gestoorde gidsinskrywing en transaksiegeskiedenis na via die ondersteunde rekeningproses of die ondersteuningsdiens. Laat die operateur se bevestigde verwerkingstyd toe; hierdie API bepaal geen gewaarborgde sperdatum vir verspreiding nie.
- Wanneer die resultaat onseker is, laat die ondersteuningsdiens die operateur se bestelling en die plaaslike fakturering rekonsilieer voordat jy weer probeer. ’n Herhaalde versoek is nie ’n idempotente statuskontrole nie.