Pataisyti esamą pranešimų siuntimo prekės ženklą
Pasikeitus įmonės kontaktiniams duomenims ar adresui, atnaujinkite esamą prekės ženklą. Išsaugokite jo identifikatorių; kitos registracijos kūrimas nėra būdas pataisyti esamos įmonės duomenis. Naudokite įjungtą API paskyrą ir junkitės per HTTPS iš leidžiamo šaltinio IP adreso. Prekės ženklas turi priklausyti tai paskyrai.
Pirmiausia nuskaitykite dabartinį įrašą. Vietinę kopiją laikykite konfidencialiai, nes joje yra įmonės tapatybės ir kontaktinių duomenų.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID" \
--output current-brand.jsonIšsaugoti dabartinius prekės ženklo laukus
Iš dabartinio įrašo paruoškite brand-update.json, pasirinkdami tik įrašomus prekės ženklo laukus. Atlikdami numatytą pataisymą, išsaugokite įmonės tapatybės duomenis ir kitas privalomas reikšmes. Nesiųskite viso GET atsakymo: brandId, tapatybės ir būsenos rezultatai, laiko žymos ir kiti tik atsakyme pateikiami laukai neturi būti įtraukti į atnaujinimą.
Atnaujinimo schemoje privalomi entityType, displayName, country, email ir brandRelationship. Subjekto tipui taikomos taisyklės lieka galioti. Organizacijos atveju išsaugokite oficialų įmonės pavadinimą, mokesčių mokėtojo identifikatorių ir jį išdavusią šalį, adresą bei veiklos sritį, kai tai taikoma. Individualaus verslininko atveju vietoj jų išsaugokite atitinkamus asmens vardo, pavardės ir mobiliojo ryšio kontaktų laukus. Naudokite tikras dabartines reikšmes, o ne registracijos pavyzdyje pateiktus pakaitinius duomenis.
| Laukai | Kaip juos naudoti |
|---|---|
| displayName, email, phone | Atpažįstamas prekės ženklo pavadinimas ir galiojantys kontaktiniai duomenys. Didžiausi ilgiai: 255, 100 ir 20 simbolių. Telefono numerį pateikite tarptautiniu formatu su + ir šalies kodu. |
| street, city, state, postalCode, country | Tarpusavyje derantys tikro įmonės adreso duomenys. Ribos: 255, 100, 20, 10 ir 2 simboliai. Kai taikoma, naudokite galiojančius JAV valstijų kodus. |
| entityType, companyName, ein, einIssuingCountry | Teisinės tapatybės duomenys. Jų keitimas ribojamas, kai kampanijos arba išorinis vertinimas yra laukiantys ar vykdomi. Nešalinkite veikiančių kampanijų vien tam, kad apeitumėte tapatybės duomenų keitimo apribojimą. |
| firstName, lastName, mobilePhone, businessContactEmail | Tapatybės duomenys arba patvirtinimui skirti kontaktai, kai jie tinka subjekto tipui. Ribos: 100, 100, 20 ir 255 simboliai. |
| brandRelationship, vertical | Dabartiniai ryšio su prekės ženklu ir veiklos srities kodai. Ryšį galima keisti ne dažniau kaip kartą per tris mėnesius. Įprastoje portalo redagavimo formoje ryšio keisti negalima. |
| website, altBusinessIdType, altBusinessId, stockSymbol, stockExchange | Kai taikoma, svetainės, alternatyvios įmonės tapatybės ir bendrovės, kurios akcijomis prekiaujama viešai, duomenys. Išsaugokite subjekto patvirtinimui reikalingas reikšmes. |
| referenceId, ipAddress | Palaikomi įmonės nuorodos ir šaltinio IP adreso metaduomenys. Nė vienas iš šių laukų nenustato priklausomybės paskyrai ir neatlieka užklausos idempotentiškumo rakto vaidmens. |
Naudokite naujausius pranešimų siuntimo katalogus kodams rasti. Atnaujinimo schemoje mock nenumatytas kaip būdas pakeisti prekės ženklo aplinką. Užuot keitę šią žymą redaguodami, naudokite atskirą peržiūrėtą perėjimo iš bandomosios į gamybinę aplinką procesą.
Pateikti peržiūrėtą pataisymą
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
--request PUT \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @brand-update.json \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID"Šiam numatytam atnaujinimui naudokite vieną raktą ir išsaugokite tikslius užklausos turinio baitus. Pakartotinai naudojant jį su pakeistu metodu, keliu, užklausos parametrais ar turiniu kyla konfliktas; pakeitus JSON formatavimą taip pat pasikeičia kontrolinis atspaudas. Dar vykdomos užklausos dublikatas gali grąžinti 409 su Retry-After. Užbaigta užklausa gali pakartotinai grąžinti išsaugotą rezultatą, įskaitant klaidą. Aiškindamiesi pasibaigusio laukimo laiko atvejį, išsaugokite užklausos duomenis, užuot automatiškai generavę naują raktą.
Patikrinti išsaugotą įrašą ir patvirtinimo būseną
Sėkmingai atnaujinus grąžinamas HTTP 200 ir tiesioginis prekės ženklo JSON objektas be senosios v3 status/response struktūros. Patikrinkite jo brandId, tada dar kartą nuskaitykite tą patį prekės ženklą naudodami GET ir palyginkite numatytus laukus. Viešasis atnaujinimo maršrutas nepriima portalo changes/version apvalkalo ir neatlieka jo optimistinės lygiagretaus redagavimo patikros. Derinkite vienu metu redaguojančių asmenų darbą; idempotentiškumo raktas apsaugo nuo pakartotinio pateikimo, bet ne nuo kito redaguotojo pakeitimų.
Dabartinis portalas nuskaito prekės ženklą, išsaugo jo įrašomus laukus, prieš išsaugodamas patikrina formos versiją ir dar kartą nuskaito rezultatą. Aptikęs aktyvių kampanijų, jis užrakina pagrindinius teisinės tapatybės laukus. Registras gali nustatyti papildomų apribojimų, įskaitant išorinio vertinimo apribojimus, net jei formoje lauką buvo leidžiama keisti.
Išsaugojus pataisytą informaciją, naujas tapatybės patvirtinimas automatiškai neužsakomas ir patvirtinimas negarantuojamas. Pakartotinis tapatybės patvirtinimas yra atskiras veiksmas, už kurį gali būti taikomas mokestis; portale peržiūrėkite dabartinę būseną ir aiškiai patvirtinkite bet kokį nurodytą mokestį. Įprasti prekės ženklo PUT atnaujinimai dabartinėje API tarnyboje nesukelia atskiro registracijos mokesčio nuskaičiavimo. Esami kampanijų, pranešimų siuntimo ir kiti mokesčiai lieka atskiri.
Išspręsti klaidas neregistruojant dublikato
Perskaitykite HTTP būseną ir JSON klaidos duomenis. Gavę 400, pataisykite konkretų lauką arba laikykitės tapatybės duomenų ar ryšio keitimo apribojimo. Gavę 401, 403 arba 404, patikrinkite prisijungimo duomenis, leidžiamą šaltinio IP adresą ir priklausomybę paskyrai. Gavę 429, laikykitės Retry-After nurodymo. 500 arba 502 gali būti grąžintas registrui jau priėmus atnaujinimą; išsaugokite bet kokį gautą requestId ir prieš pateikdami dar kartą nuskaitykite esamą įrašą.
Netuščias, bet neišsamus atnaujinimo atsakymas gali palikti neišsamią vietinę duomenų kopiją; tuščias sėkmingo atsakymo turinys gali palikti senesnius tos kopijos laukus. Vien iš sėkmės būsenos nespręskite, kad laukai buvo išsaugoti. Iš naujo nuskaitykite visus prekės ženklo duomenis ir bet kokius neatitikimus išspręskite padedami palaikymo tarnybos. Šiame vadove nežadama, kad registro, vietinės podėlio atminties ir atsiskaitymo duomenys bus atnaujinti atomiškai.