MultiTEL
Програмери

GET/tcr/v2/campaignBuilder/brand/{brand_id}

Проверите доступне намене кампања за бренд

Сазнајте које намене кампања регистар нуди за постојећи бренд на вашем налогу пре него што од клијента затражите да подеси кампању.

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

Изаберите постојећи бренд на свом налогу

Почните од идентификатора бренда у регистру који је већ повезан са вашим MultiTEL налогом. Овај упит не креира бренд нити повезује туђи бренд са вашим налогом. Тренутни ток рада за клијенте проверава власништво пре него што затражи податке о испуњавању услова. Ако упит врати 404, проверите изабрани налог и бренд уместо да употребите идентификатор реда из локалне базе.

На основу овог резултата саставите понуду намена

Општи каталог намена описује опције регистра. Овај упит за одређени бренд даје доступне изборе за изабрани бренд. Сачувајте сваку враћену usecase вредност и повежите је са називом за приказ и описом из каталога. Немојте нудити сваку ставку из општег каталога као да бренд испуњава услове за њу.

Портал очекује да овај одговор буде листа у формату JSON. Ако одговор недостаје, није исправно обликован или представља грешку, сачувајте клијентов образац и прикажите обавештење да подаци о испуњавању услова нису могли да се учитају. Немојте то прећутно сматрати одобрењем за подразумевану намену. Регистар може вратити и поља која нису приказана у скраћеном примеру.

Учитајте захтеве за изабрану намену

Када клијент изабере једну од враћених вредности намене, пошаљите захтев на /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} за исти бренд. Тај одговор даје ограничења за поднамене и захтеве специфичне за оператере. Користите га да прикупите примере порука, сагласност и друге обавезне изјаве. Сама листа намена за које бренд испуњава услове није довољна за састављање потпуне пријаве за регистрацију кампање.

Засебно прегледајте цене за налог

Поља добављача као што су monthlyFee, quarterlyFee или annualFee, када су враћена, описују метаподатке о накнадама добављача. Она не замењују цену за клијентов налог нити услове регистрације. Тренутни портал засебно учитава малопродајне цене кампања и спаја их са подацима о испуњавању услова на екрану за преглед. Немојте изводити износ који се наплаћује клијенту из цена фиксно уписаних у код старе помоћне функције за набрајања.

Освежите податке када се бренд или намена промени

При промени бренда одбаците изборе претходног бренда и учитајте податке о испуњавању услова за нови избор. Освежите захтеве за изабрану намену пре слања пријаве. Ови GET захтеви не подносе пријаву за регистрацију, не активирају кампању нити додељују бројеве.

Захтев

Користите омогућен API налог преко HTTPS са дозвољене изворне IP адресе. Тренутна рута подржава политику аутентификације налога, укључујући Basic аутентификацију и омогућене API налоге са аутентификацијом помоћу приступног токена. Немојте користити акредитиве добављача.

GET са идентификатором бренда у URL путањи. Тело захтева није потребно.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"
Параметри путање
НазивТипОбавезноОпис
brand_idзнаковни низДаИдентификатор бренда у регистру повезан са вашим аутентификованим MultiTEL налогом. Користите идентификатор бренда, а не идентификатор реда у локалној бази података, идентификатор кампање или порески идентификациони број предузећа. Кодирајте га као један сегмент URL путање.

Одговор

Тренутна TCR рута непосредно враћа тело одговора регистра у формату JSON и задржава његов HTTP статус. Не додаје стари омотач status/response из верзије v3. Скраћени измишљени пример није стварни резултат провере испуњавања услова. Пре употребе проверите HTTP статус и очекивану JSON структуру. Тренутни портал очекује листу записа о испуњавању услова, од којих сваки наводи usecase. Те записе повезује са каталогом usecase ради добијања назива за приказ, а малопродајне цене учитава засебно. Могу бити присутна и додатна поља добављача.

Илустративна структура одговора; не представља стварне податке налога нити актуелну понуду цене.

[
  {
    "usecase": "2FA"
  }
]

Грешке

  • 401: Аутентификација налога није успела. Проверите API акредитиве, да ли је налог омогућен и важећа ограничења за изворне IP адресе.
  • 404: Бренд није повезан са аутентификованим налогом или добављач не може да пронађе тражени бренд или избор. Локално одбијање због непотврђеног власништва враћа се пре слања захтева добављачу.
  • Остале грешке регистра: задржавају се HTTP статус и тело одговора узводног сервиса. Неважећа или недоступна намена не представља успешно добијен празан скуп захтева.
  • 429: Достигнуто је ограничење броја захтева за налог или заједничко ограничење добављача. Поштујте Retry-After.
  • 502/503: Грешка у преносу или недоступност добављача или механизма за ограничавање учесталости захтева. Сачувајте образац и поновите покушај уз постепено повећавање времена чекања.

Доступност и пратећи ефекти

  • Прегледани GET захтев проверава власништво над постојећим брендом, контактира регистар и уписује записе за ревизију захтева. Не креира бренд или кампању нити наплаћује накнаду за регистрацију.
  • Метаподаци о накнадама добављача нису понуда малопродајне цене за MultiTEL клијента. Портал засебно прегледа цене за налог пре каснијег захтева за регистрацију.
  • Испуњавање услова и захтеви могу се променити. Освежите те податке за изабрани бренд и намену пре подношења пријаве. Успешан упит не представља одобрење кампање, доделу бројева нити дозволу за почетак слања порука.