Зареждане на каталози за регистрация за обмен на съобщения

Заредете възможностите за избор, преди да създадете формуляр за регистрация

Използвайте актуалния каталог за регистрация за обмен на съобщения, за да попълните възможностите за избор, вместо да задавате стойностите на регистъра фиксирано в кода. За формуляр за марка порталът зарежда каталози за вид предприятие, отрасъл, вид алтернативен бизнес идентификатор, отношение към марката, държава, щат на САЩ и фондова борса. За формуляр за кампания зарежда предназначения, валидни подкатегории на предназначенията и партньори за свързаност. Съхранявайте всяка върната машинна стойност заедно с нейния етикет за показване; при съставяне на последваща заявка използвайте стойността, а не преведен етикет.

Изберете каталог

Обработете директно отговора от TCR

Тялото на отговора идва директно от TCR API. За разлика от много по-стари /v3 крайни точки, то няма добавена обвивка status/response. Проверете статуса HTTP, преди да интерпретирате отговора. Каталогът може да съдържа текстови етикети или структурирани дефиниции, затова не приемайте, че всяка стойност има едни и същи полета. Ако заявката HTTP е успешна, но тялото не е валиден JSON с очакваната структура, съобщете за неуспешно извличане, вместо да го заменяте мълчаливо с празен списък.

Разграничете възможностите в каталога от проверката за допустимост и ценообразуването

Общият каталог на предназначенията не показва за кои предназначения конкретна марка отговаря на условията. Текущият портал извършва проверка за допустимост за конкретната марка преди създаването на кампания и проверява изискванията на избрания оператор. По същия начин метаданните за таксите на доставчика не са крайната цена на дребно за акаунта. Прегледайте отделно приложимата цена за акаунта и условията за регистрация. Зареждането на каталог не одобрява марка, кампания или номер за обмен на съобщения.

Действия при недостъпни каталози

Запазете въведеното от клиента във формуляра, ако извличането е неуспешно. Покажете грешката, спазвайте Retry-After при получаване и увеличавайте постепенно интервала между повторните опити. Не презареждайте многократно всички каталози и не третирайте грешка поради ограничение на честотата на заявките или грешка при преноса като празен валиден каталог. Тази заявка GET не изисква ключ за идемпотентност и не се възпроизвежда от хранилището за идемпотентност на променящите операции.

Заявка

Използвайте активиран API акаунт през HTTPS от разрешен изходен IP адрес. Текущият маршрут поддържа правилата за удостоверяване на акаунта, включително удостоверяване Basic и активирани API акаунти с токен на приносител. Не използвайте идентификационните данни на доставчика.

Изпратете GET с поддържано име на каталог в пътя. Подайте приложимите филтри за каталога в низа на заявката. Не е необходимо тяло на заявката.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Отговор

Този маршрут на TCR връща директно тялото на отговора от регистъра заедно с неговия статус HTTP. Не използва по-старата обвивка v3 status.code/status.msg/response. Структурите на каталозите се различават: някои съпоставят стойности с описателни обекти, а други — с текстови низове. Запазете машинночетимите ключове при последващо изпращане на формуляр. Съкратеният измислен пример за usecase илюстрира съпоставяне със стойности обекти, а не действителен актуален каталог или гарантирано пълна схема. Проверявайте както статуса HTTP, така и очакваната структура на JSON.

Примерна структура на отговор; това не са действителни текущи данни за акаунта или актуална оферта.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Грешки

• 401: Удостоверяването на акаунта е неуспешно. Проверете идентификационните данни за API, дали акаунтът е активиран и приложимите ограничения за изходния IP адрес.
• 400/404 и други грешки на регистъра: невалиден или недостъпен каталог или филтър. Текущият маршрут запазва статуса HTTP и тялото на отговора от горестоящата услуга; няма универсална обвивка за грешки на v3.
• 429: Достигнат е лимитът за заявки на акаунта или споделеният лимит на доставчика. Спазвайте Retry-After и опитайте отново с постепенно увеличаване на интервала.
• 502: Връзката с регистъра не можа да бъде установена. Наличността е неизвестна; не представяйте празни възможности за избор като успешен резултат.
• 503: Механизмът за ограничаване на заявките или горестоящата услуга е недостъпен. Преди да опитате отново, прегледайте тялото на отговора и заглавката Retry-After, ако е налична.

Наличност и странични ефекти

• Тази заявка GET за каталог не създава марка или кампания, не подава регистрация, не резервира ресурс и не начислява такса за регистрация в прегледания път на изпълнение. Тя се свързва с доставчика и създава одитни записи за заявката.
• Дефинициите на каталозите и евентуалните метаданни за таксите на доставчика не представляват оферта на дребно за клиента. Текущият портал получава отделно цените на дребно за кампаниите; остарялата помощна функция getCampaignPrice и старите бележки за цени в изброяванията не трябва да се приемат за договорените правила за ценообразуване на този маршрут.
• Поддържан запис в каталога не е доказателство, че конкретна марка отговаря на условията за съответното предназначение. Преди последваща заявка за регистрация завършете проверката за допустимост на конкретната марка, подайте декларациите и съгласието и прегледайте цените за акаунта.