Достъп до акаунта и проекта
Използвайте активиран 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 данните или представянето в портала. Прегледаният обработчик за подробности не променя проекта и не задейства пряко заявка към оператор или начисляване на такса.