Приступ налогу и пројекту
Користите омогућен API налог преко протокола HTTPS са дозвољене IP адресе. Пројекат мора припадати том налогу и не сме бити обрисан. Користите јединствени идентификатор пројекта из поступка наручивања преноса бројева, а не његов нумерички идентификатор у бази података или телефонски број. При састављању захтева примените URL кодирање на идентификатор пројекта.
Захтев
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID"Поступајте са овим одговором као са поверљивим подацима
Потпуни одговор садржи податке за обрачун код оператера од којег се бројеви преносе, укључујући сачувани billing_pin, податке о обрачунском налогу, телефону, адреси, компанији и овлашћеној особи за контакт. API не маскира ова поља. Затражите само статус или листу бројева ако је то све што је потребно вашем радном току. Не чувајте потпуни детаљни одговор у складишту прегледача, аналитичким системима, јавним евиденцијама или снимцима екрана за подршку и приказујте само поља која су потребна овлашћеном кориснику.
Структура одговора
Измишљени пример са одабраним пољима; одговор може садржати и додатна поља.
{
"status": {
"code": 200,
"msg": "Project Detail"
},
"response": {
"project": {
"id": 11,
"uniqueid": "PROJECT_EXAMPLE",
"project_name": "Example transfer",
"location": "US",
"status": 0,
"status_str": "Pending"
},
"counts": {
"total": 0,
"pending": 0,
"in_progress": 0,
"completed": 0,
"rejected": 0
},
"numbers": [],
"events": [],
"uploads": []
}
}Овај намерно непотпун пример изоставља све приступне податке за обрачун и личне контакт податке. Њихово изостављање из примера не значи да их стварни одговор прикрива.
| Одељак | Садржај |
|---|---|
| project | Нумерички идентификатор реда, јединствени идентификатор пројекта, назив пројекта, локација, сачувани подаци за обрачун, контакт и адресу, време креирања и изведени статус. Наслеђено поље за оператера од којег се бројеви преносе има назив loosing_carrier. |
| counts | Укупан број редова са телефонским бројевима и бројачи за статусе Pending, In Progress, Completed и Rejected. |
| numbers | Иста пројекција података о бројевима као на крајњој тачки за листу бројева пројекта, укључујући коментаре корисника и сачуване вредности заказивања. |
| events | Сачувани редови догађаја и поља са необрађеним и рашчлањеним садржајем, уз ограничења видљивости и формата крајње тачке за догађаје. |
| uploads | Метаподаци докумената: нумерички идентификатор, upload_type, file_name, file_extension, date_created и релативни download_url. Приступ тој URL адреси и даље захтева аутентификацију налога. |
Тумачење сажетка и метаподатака
При одређивању изведеног статуса предност има In Progress, затим Pending, па Completed, а потом Rejected; ако ниједан од њих није применљив, користи се Pending. Сажети статус Completed може постојати и када има одбијених бројева. Проверите бројаче и статусе појединачних бројева уместо да претпоставите да је пренос сваког броја завршен.
Одговор садржи метаподатке докумената, а не бајтове датотека. Нема пагинацију нити курсор за инкрементално преузимање. Упити за детаље и листу представљају засебна читања, а не један снимак стања са гарантованом трансакционом доследношћу. Датуми остају ускладиштене вредности, без документованог претварања временске зоне. За руте пројекта користите uniqueid; нумерички идентификатор пројекта не може се користити као замена.
Грешке и ограничења
Проверите и HTTP одговор и status.code/status.msg. За пројекат који не постоји, који је обрисан или који не припада налогу враћа се API код 404 са поруком да пројекат није пронађен. Примењују се и захтеви за аутентификацију и ограничења изворне IP адресе. Примери не шаљу стварни захтев, а успешан одговор није доказ да је оператер прихватио или завршио пренос.
Ефекти и радни ток
Ово је канонска рута за детаље коју користи приказ налога за пренос бројева у тренутном порталу. Портал мапира поља за свој кориснички интерфејс и примењује сопствену пројекцију података за кориснике; немојте претпостављати да је необрађени API одговор истоветан формату JSON или приказу портала. Прегледани обрађивач детаља не мења пројекат нити непосредно покреће захтев оператеру или наплату.