Sõnumside kaubamärgi uuendamine

Parandage olemasoleva sõnumside kaubamärgi andmeid

Uuendage olemasolevat kaubamärki, kui ettevõtte kontaktandmed või aadress muutuvad. Säilitage selle kaubamärgi ID; olemasoleva ettevõtte andmete parandamiseks ei tule luua uut registreeringut. Kasutage lubatud lähte-IP-aadressilt aktiveeritud API kontot HTTPS kaudu. Kaubamärk peab kuuluma sellele kontole.

Alustage praeguse kirje lugemisest. Hoidke kohalik koopia privaatsena, sest see sisaldab ettevõtte identifitseerimis- ja kontaktandmeid.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID" \
  --output current-brand.json

Säilitage kaubamärgi praegused väljad

Koostage praeguse kirje põhjal brand-update.json, valides ainult kirjutatavad kaubamärgiväljad. Kavandatud parandust tehes säilitage ettevõtte identifitseerimisandmed ja muud nõutavad väärtused. Ärge saatke kogu GET vastust: brandId, identiteedi- ja olekutulemused, ajatemplid ning muud ainult vastusesse kuuluvad väljad ei kuulu uuendusse.

Uuendusskeem nõuab välju entityType, displayName, country, email ja brandRelationship. Üksuse liigile kehtivad reeglid jäävad jõusse. Organisatsiooni puhul säilitage vajaduse järgi selle ametlik ärinimi, maksukohustuslase tunnus ja selle väljastanud riik, aadress ning tegevusala. Füüsilisest isikust ettevõtja puhul säilitage selle asemel asjakohased isikunime ja mobiiltelefoni kontaktandmete väljad. Kasutage tegelikke kehtivaid väärtusi, mitte registreerimisnäite kohatäiteid.

Kaubamärgi uuendamise väljarühmad
Väljad	Kuidas neid kasutada
displayName, email, phone	Äratuntav kaubamärginimi ja kehtivad kontaktandmed. Maksimumpikkused: 255, 100 ja 20 märki. Kasutage rahvusvahelist telefoninumbri vormingut, kus riigikoodi ees on +.
street, city, state, postalCode, country	Ettevõtte tegelik aadress, mille osad on omavahel kooskõlas. Piirangud: 255, 100, 20, 10 ja 2 märki. Kasutage vajaduse korral kehtivaid USA osariigikoode.
entityType, companyName, ein, einIssuingCountry	Juriidilised identifitseerimisandmed. Nende muutmine on piiratud, kui kampaaniad või välised taustakontrollid on ootel või aktiivsed. Ärge kustutage toimivaid kampaaniaid üksnes identiteediandmete muutmise piirangust möödahiilimiseks.
firstName, lastName, mobilePhone, businessContactEmail	Identifitseerimisandmed või kontrollimiseks vajalikud kontaktandmed, kui need on üksuse liigi puhul asjakohased. Piirangud: 100, 100, 20 ja 255 märki.
brandRelationship, vertical	Kehtivad suhte- ja tegevusalakoodid. Suhet saab muuta kõige rohkem kord kolme kuu jooksul. Portaali tavaline muutmisvorm ei võimalda suhet muuta.
website, altBusinessIdType, altBusinessId, stockSymbol, stockExchange	Asjakohane veebisait, ettevõtte alternatiivsed identifitseerimisandmed ja börsiettevõtte andmed. Säilitage üksuse valideerimiseks vajalikud väärtused.
referenceId, ipAddress	Toetatud ettevõtte viite ja lähte-IP-aadressi metaandmed. Kumbki väli ei määra kontole kuuluvust ega toimi päringu idempotentsusvõtmena.

Kasutage kehtivaid sõnumside katalooge koodide leidmiseks. Uuendusskeem ei võimalda kasutada välja mock kaubamärgi keskkonna muutmiseks. Kasutage eraldi ülevaadatud töövoogu liivakastist tootmiskeskkonda üleminekuks, selle asemel et seda lippu muutmise käigus muuta.

Esitage ülevaadatud parandus

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"

Kasutage selle kavandatud uuenduse jaoks üht võtit ja säilitage päringu sisu täpsed baidid. Selle taaskasutamine muudetud meetodi, tee, päringuparameetrite või sisuga põhjustab konflikti; ka JSON ümbervormindamine muudab sõrmejälge. Veel töös oleva päringu duplikaat võib tagastada 409 koos päisega Retry-After. Lõpetatud päring võib taasesitada oma salvestatud tulemuse, sealhulgas vea. Ajalõpu järel tulemuse väljaselgitamiseks säilitage päringu üksikasjad, selle asemel et automaatselt uus võti luua.

Kontrollige salvestatud kirjet ja valideerimisolekut

Edukas uuendus tagastab HTTP 200 ja otse kaubamärgi JSON objekti ilma pärandversiooni v3 status/response ümbriseta. Kontrollige selle välja brandId väärtust, seejärel lugege sama kaubamärk uuesti meetodiga GET ja võrrelge kavandatud välju. Avalik uuendusmarsruut ei võta vastu portaali changes/version ümbrist ega paku selle optimistlikku samaaegsuskontrolli. Kooskõlastage samaaegsete muutjate tegevus; idempotentsusvõti takistab korduvat esitamist, kuid ei takista teise muutja muudatusi.

Praegune portaal loeb kaubamärgi andmed, säilitab selle kirjutatavad väljad, kontrollib enne salvestamist vormi versiooni ning loeb tulemuse uuesti. Aktiivsete kampaaniate leidmisel lukustab see peamised juriidiliste identifitseerimisandmete väljad. Register võib kehtestada lisapiiranguid, sealhulgas välise taustakontrolliga seotud piiranguid, isegi kui väli oli vormis saadaval.

Parandatud andmete salvestamine ei taotle automaatselt uut identiteedikontrolli ega taga heakskiitu. Korduskontroll on eraldi toiming, mis võib olla tasuline; vaadake portaalis praegune olek üle ja kinnitage sõnaselgelt iga pakutud tasu. Tavalised kaubamärgi PUT uuendused ei käivita praeguses API teenuses eraldi registreerimistasu debiteerimist. Olemasolevad kampaania-, sõnumside- ja muud tasud jäävad eraldiseisvaks.

Lahendage vead uut registreeringut loomata

Lugege HTTP olekut ja JSON vea üksikasju. Koodi 400 korral parandage konkreetne väli või järgige identiteediandmete või suhte muutmise piirangut. Koodide 401, 403 või 404 korral kontrollige autentimisandmeid, lubatud lähte-IP-aadressi ja kontole kuuluvust. Koodi 429 korral järgige päist Retry-After. Viga 500 või 502 võib ilmneda pärast seda, kui register on uuenduse vastu võtnud; säilitage iga saadud requestId ja lugege enne uut esitamist olemasolevat kirjet.

Mittetühi, kuid mittetäielik uuendusvastus võib jätta kohaliku hetktõmmise poolikuks; tühi eduka vastuse sisu võib jätta alles hetktõmmise vanemad väljad. Ärge järeldage üksnes eduka oleku põhjal, et väljad säilisid. Lugege kaubamärgi täielikud andmed uuesti ja lahendage kõik lahknevused klienditoe kaudu. See juhend ei taga registri, kohaliku vahemälu ja arvelduse uuenduste atomaarsust.