Vývojáři

PUT/tcr/v2/brand/{brandId}

Aktualizace značky pro zasílání zpráv

Opravte firemní a kontaktní údaje, zachovejte stávající registraci a zkontrolujte stav jejího ověření.

Na této stránce
  1. Oprava stávající značky pro zasílání zpráv
  2. Zachování aktuálních polí značky
  3. Odeslání zkontrolované opravy
  4. Kontrola uloženého záznamu a stavu ověření
  5. Řešení chyb bez duplicitní registrace

Oprava stávající značky pro zasílání zpráv

Při změně firemních kontaktních údajů nebo adresy aktualizujte stávající značku. Zachovejte její identifikátor; vytvoření další registrace není způsob, jak opravit údaje stávající firmy. Použijte aktivovaný účet API a připojení přes HTTPS z povolené zdrojové IP adresy. Značka musí patřit tomuto účtu.

Nejprve načtěte aktuální záznam. Místní kopii uchovávejte v soukromí, protože obsahuje identifikační a kontaktní údaje firmy.

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

Zachování aktuálních polí značky

Z aktuálního záznamu připravte brand-update.json a vyberte pouze pole značky, do kterých lze zapisovat. Při provádění zamýšlené opravy zachovejte identifikační údaje firmy a ostatní povinné hodnoty. Neodesílejte celou odpověď GET: brandId, výsledky ověření identity a stavu, časová razítka ani další pole určená pouze pro odpověď do aktualizace nepatří.

Schéma aktualizace vyžaduje entityType, displayName, country, email a brandRelationship. Nadále platí pravidla pro daný typ subjektu. U organizace zachovejte její oficiální název, daňový identifikátor a zemi jeho vydání, adresu a odvětví, pokud se na ni tyto údaje vztahují. U fyzické osoby podnikatele místo toho zachovejte příslušná pole s osobním jménem a mobilním kontaktem. Použijte skutečné aktuální hodnoty, nikoli zástupné hodnoty z příkladu registrace.

Skupiny polí pro aktualizaci značky
PoleJak je používat
displayName, email, phoneRozpoznatelný název značky a platné kontaktní údaje. Maximální délky: 255, 100 a 20 znaků. Telefonní čísla uvádějte v mezinárodním formátu se znakem + a předvolbou země.
street, city, state, postalCode, countrySkutečná firemní adresa se vzájemně odpovídajícími údaji. Limity: 255, 100, 20, 10 a 2 znaky. V příslušných případech použijte aktuální kódy států USA.
entityType, companyName, ein, einIssuingCountryPrávní identita. Tyto změny jsou omezeny, pokud kampaně nebo externí prověřování čekají na vyřízení či probíhají. Nemažte fungující kampaně jen proto, abyste obešli omezení změny identity.
firstName, lastName, mobilePhone, businessContactEmailIdentifikační údaje nebo kontakty pro ověření, pokud odpovídají typu subjektu. Limity: 100, 100, 20 a 255 znaků.
brandRelationship, verticalAktuální kódy vztahu ke značce a odvětví. Vztah lze změnit nejvýše jednou za tři měsíce. Běžný formulář pro úpravy v portálu změny vztahu nenabízí.
website, altBusinessIdType, altBusinessId, stockSymbol, stockExchangePříslušné webové stránky, alternativní identifikační údaje firmy a údaje o veřejně obchodované společnosti. Zachovejte hodnoty potřebné k ověření subjektu.
referenceId, ipAddressPodporovaná metadata s referenčním údajem firmy a zdrojovou IP adresou. Ani jedno neurčuje příslušnost k účtu ani neslouží jako idempotentní klíč požadavku.

Kódy vyhledejte v aktuálních katalozích pro zasílání zpráv. Schéma aktualizace nenabízí mock jako způsob změny prostředí značky. Místo změny tohoto příznaku při úpravě použijte samostatný zkontrolovaný postup přechodu z testovacího prostředí do produkčního.

Odeslání zkontrolované opravy

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"

Pro tuto zamýšlenou aktualizaci použijte jeden klíč a uchovejte přesnou posloupnost bajtů těla požadavku. Opětovné použití klíče se změněnou metodou, cestou, parametry dotazu nebo tělem způsobí konflikt; otisk se změní i přeformátováním JSON. Duplicitní požadavek, jehož původní zpracování stále probíhá, může vrátit 409 s hlavičkou Retry-After. Dokončený požadavek může znovu vrátit uložený výsledek včetně chyby. Při objasňování výsledku po vypršení časového limitu uchovejte podrobnosti požadavku a negenerujte automaticky nový klíč.

Kontrola uloženého záznamu a stavu ověření

Úspěšná aktualizace vrátí HTTP 200 a přímo objekt značky ve formátu JSON, bez původní obálky v3 status/response. Zkontrolujte jeho brandId, poté znovu načtěte stejnou značku pomocí GET a porovnejte zamýšlená pole. Veřejná cesta pro aktualizaci nepřijímá obálku changes/version používanou portálem ani neposkytuje jeho optimistickou kontrolu souběžných změn. Koordinujte uživatele provádějící souběžné úpravy; idempotentní klíč zabraňuje duplicitnímu odeslání, nikoli změnám provedeným jiným uživatelem.

Současný portál načte značku, zachová její zapisovatelná pole, před uložením zkontroluje verzi formuláře a znovu načte výsledek. Pokud zjistí aktivní kampaně, uzamkne základní pole právní identity. Registr může uplatnit další omezení, včetně omezení souvisejících s externím prověřováním, i když formulář dané pole nabízel.

Uložení opravených údajů automaticky nevyžádá nové ověření identity ani nezaručuje schválení. Opětovné ověření je samostatný úkon, který může být zpoplatněn; v portálu zkontrolujte aktuální stav a výslovně potvrďte případný uvedený poplatek. Běžné aktualizace značky pomocí PUT v současné službě API nevyvolávají samostatné stržení registračního poplatku. Stávající poplatky za kampaně, zasílání zpráv a další služby zůstávají oddělené.

Řešení chyb bez duplicitní registrace

Přečtěte si stav HTTP a podrobnosti chyby ve formátu JSON. Při 400 opravte konkrétní pole nebo respektujte omezení změny identity či vztahu. Při 401, 403 nebo 404 zkontrolujte přihlašovací údaje, povolenou zdrojovou IP adresu a příslušnost značky k účtu. Při 429 dodržte Retry-After. Chyba 500 nebo 502 může nastat i poté, co registr aktualizaci přijal; uchovejte případný requestId a před dalším odesláním načtěte stávající záznam.

Neprázdná, ale neúplná odpověď na aktualizaci může zanechat neúplný místní snímek; prázdné tělo úspěšné odpovědi může ponechat starší pole snímku. Ze samotného stavu úspěchu nevyvozujte, že byla pole zachována. Znovu načtěte úplný záznam značky a případné nesrovnalosti vyřešte prostřednictvím podpory. Tato příručka nezaručuje atomické aktualizace registru, místní mezipaměti a účtování.