MultiTEL
Програмери

GET/tcr/v2/enum/{type}

Учитавање каталога за регистрацију размене порука

Учитајте актуелне опције за брендове и кампање за размену порука, укључујући врсте предузећа, привредне гране и намене. Ови каталози обезбеђују вредности за обрасце; не региструју нити одобравају кампању.

На овој страници
  1. Учитајте опције пре израде обрасца за регистрацију
  2. Изаберите каталог
  3. Обрадите одговор TCR директно
  4. Раздвојите опције каталога од провере испуњености услова и одређивања цена
  5. Поступање када каталози нису доступни
  6. Захтев
  7. Одговор
  8. Грешке
  9. Доступност и споредни ефекти

Учитајте опције пре израде обрасца за регистрацију

Користите актуелни каталог за регистрацију размене порука да попуните опције, уместо да вредности регистра фиксно уграђујете у код. За образац бренда портал учитава каталоге врста предузећа, привредних грана, врста алтернативних пословних идентификатора, односа са брендом, држава, савезних држава САД и берзи. За образац кампање учитава намене, важеће поднамене и партнере за повезивање. Чувајте сваку враћену машинску вредност заједно са њеном ознаком за приказ; при састављању каснијег захтева користите вредност, а не преведену ознаку.

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

Каталози које портал користи
НазивСврха
usecaseДефиниције намена кампање. Додајте validSubUsecase=true када учитавате опције поднамена.
entityTypeВрста предузећа или организације за бренд.
verticalОпције привредних грана за бренд.
altBusinessIdTypeКатегорије алтернативних пословних идентификатора.
brandRelationshipОпције односа које се користе у обрасцу за регистрацију.
countryОпције држава у регистру; оне су одвојене од држава у којима су доступни телефонски бројеви.
usStateОпције савезних држава САД за адресе при регистрацији.
stockExchangeОпције берзи када их захтева врста предузећа бренда.
cnpИдентификатори партнера за повезивање. Изаберите партнера којег подржава ток рада за кампање на вашем налогу.

Обрадите одговор 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"
Параметри путање
НазивТипОбавезноОпис
typeтекстуални низДаНазив каталога, уз очувана изворна велика и мала слова. Портал користи usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange и cnp. То су називи каталога, а не идентификатори брендова или кампања.
Параметри упита
НазивТипОбавезноОпис
validSubUsecaseлогичка вредностНеЗа каталог usecase портал шаље вредност 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 и старе напомене о ценама у набрајањима не смеју се сматрати уговором о ценама ове руте.
  • Подржана ставка каталога није доказ да одређени бренд испуњава услове за ту намену. Пре каснијег захтева за регистрацију обавите проверу испуњености услова за конкретан бренд, доставите изјаве и сагласност и прегледајте цене за налог.