Selectați o marcă existentă în contul dumneavoastră
Începeți cu identificatorul mărcii din registru deja asociat contului dumneavoastră MultiTEL. Această interogare nu creează o marcă și nu asociază contului dumneavoastră marca altcuiva. Fluxul actual pentru clienți verifică apartenența mărcii înainte de a solicita informațiile privind eligibilitatea. Dacă interogarea returnează 404, verificați contul și marca selectate, în loc să folosiți identificatorul unui rând local.
Construiți lista opțiunilor de utilizare pe baza acestui rezultat
Catalogul general al cazurilor de utilizare descrie opțiunile registrului. Această interogare specifică mărcii oferă opțiunile pentru marca selectată. Păstrați fiecare valoare returnată pentru usecase și combinați-o cu eticheta de afișare și descrierea din catalog. Nu oferiți toate intrările din catalogul general ca și cum marca ar fi eligibilă pentru fiecare dintre ele.
Portalul se așteaptă ca acest răspuns să fie o listă JSON. Dacă răspunsul lipsește, are un format incorect sau indică o eroare, păstrați formularul clientului și afișați faptul că informațiile privind eligibilitatea nu au putut fi încărcate. Nu îl interpretați în mod tacit drept aprobare pentru un caz de utilizare implicit. Registrul poate returna și alte câmpuri față de cele din exemplul prescurtat.
Încărcați cerințele pentru cazul de utilizare selectat
După ce un client alege una dintre valorile returnate pentru cazul de utilizare, solicitați /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} pentru aceeași marcă. Răspunsul respectiv furnizează limitele pentru subcazurile de utilizare și cerințele specifice operatorilor. Folosiți-l pentru a colecta exemple de mesaje, consimțământul și celelalte declarații necesare. Lista de eligibilitate, singură, nu este suficientă pentru a pregăti o cerere completă de înregistrare a unei campanii.
Verificați separat tarifele contului
Câmpurile furnizorului, precum monthlyFee, quarterlyFee sau annualFee, atunci când sunt returnate, descriu metadatele privind taxele furnizorului. Ele nu înlocuiesc tariful aplicabil contului clientului sau condițiile de înregistrare. Portalul actual citește separat tarifele de vânzare cu amănuntul pentru campanii și le combină cu datele de eligibilitate pentru ecranul de verificare. Nu deduceți o sumă de facturat clientului din tarifele fixate în codul vechii funcții auxiliare pentru enumerări.
Actualizați datele când se schimbă marca sau cazul de utilizare
La schimbarea mărcii, eliminați opțiunile mărcii anterioare și încărcați informațiile privind eligibilitatea pentru noua selecție. Actualizați cerințele cazului de utilizare selectat înainte de trimitere. Aceste cereri GET nu trimit o cerere de înregistrare, nu activează o campanie și nu alocă numere.
Cerere
Folosiți un cont API activat, prin HTTPS, de la o adresă IP sursă permisă. Ruta actuală acceptă politica de autentificare a contului, inclusiv autentificarea Basic și conturile API activate cu autentificare prin token de tip bearer. Nu folosiți datele de autentificare ale furnizorului.
GET cu identificatorul mărcii în calea URL. Nu este necesar un corp al cererii.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Nume | Tip | Obligatoriu | Descriere |
|---|---|---|---|
brand_id | șir de caractere | Da | Identificatorul mărcii din registru asociat contului dumneavoastră MultiTEL autentificat. Folosiți identificatorul mărcii, nu identificatorul unui rând din baza de date locală, identificatorul campaniei sau codul fiscal al firmei. Codificați-l ca un singur segment al căii URL. |
Răspuns
Ruta TCR actuală returnează direct corpul JSON al registrului și păstrează codul său de stare HTTP. Nu adaugă structura de încadrare status/response din vechea versiune v3. Exemplul fictiv prescurtat nu este un rezultat de eligibilitate obținut în timp real. Verificați codul de stare HTTP și structura JSON așteptată înainte de a utiliza răspunsul. Portalul actual se așteaptă la o listă de înregistrări de eligibilitate, fiecare identificând un usecase. Combină aceste înregistrări cu catalogul usecase pentru etichetele de afișare și citește separat tarifele de vânzare cu amănuntul. Pot fi prezente câmpuri suplimentare ale furnizorului.
Structură ilustrativă a răspunsului; nu reprezintă date ale contului în timp real sau o ofertă de preț actuală.
[
{
"usecase": "2FA"
}
]Erori
- 401: Autentificarea contului a eșuat. Verificați datele de autentificare API, dacă este activat contul și restricțiile aplicabile adreselor IP sursă.
- 404: Marca nu este asociată contului autentificat sau furnizorul nu poate găsi marca ori selecția solicitată. Dacă verificarea locală a apartenenței mărcii duce la refuz, acesta este returnat înainte de trimiterea unei cereri către furnizor.
- Alte erori ale registrului: codul de stare HTTP și corpul răspunsului primit de la sistemul din amonte sunt păstrate. Un caz de utilizare nevalid sau indisponibil nu reprezintă un rezultat reușit cu un set gol de cerințe.
- 429: A fost atinsă limita de cereri a contului sau limita comună a furnizorului. Respectați Retry-After.
- 502/503: Eroare de transport sau de disponibilitate a furnizorului ori a mecanismului de limitare a frecvenței cererilor. Păstrați formularul și reîncercați cu intervale de așteptare progresiv mai mari.
Disponibilitate și efecte secundare
- Cererea GET examinată verifică apartenența mărcii existente, contactează registrul și scrie înregistrări de audit ale cererii. Nu creează o marcă sau o campanie și nu percepe o taxă de înregistrare.
- Metadatele privind taxele furnizorului nu reprezintă o ofertă de preț de vânzare cu amănuntul pentru clientul MultiTEL. Portalul verifică separat tarifele contului înainte de o cerere ulterioară de înregistrare.
- Eligibilitatea și cerințele se pot schimba. Actualizați-le pentru marca și cazul de utilizare selectate înainte de trimitere. O interogare reușită nu reprezintă aprobarea unei campanii, alocarea unor numere sau permisiunea de a începe trimiterea mesajelor.