Päivitä viestintäbrändi

Korjaa olemassa olevan viestintäbrändin tiedot

Päivitä olemassa oleva brändi, kun yrityksen yhteystiedot tai osoite muuttuvat. Säilytä brändin tunniste; uuden rekisteröinnin luominen ei ole oikea tapa korjata olemassa olevan yrityksen tietoja. Käytä aktivoitua API-tiliä HTTPS-yhteydellä sallitusta lähde-IP-osoitteesta. Brändin on kuuluttava kyseiselle tilille.

Aloita lukemalla nykyinen tietue. Suojaa paikallinen kopiosi asiattomalta käytöltä, sillä se sisältää yrityksen tunniste- ja yhteystietoja.

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äilytä brändin nykyiset kentät

Luo brand-update.json nykyisen tietueen pohjalta ja valitse mukaan vain kirjoitettavat brändikentät. Säilytä yrityksen identiteettitiedot ja muut pakolliset arvot, kun teet aiotun korjauksen. Älä lähetä koko GET-vastausta: brandId, identiteettiä ja tilaa koskevat tulokset, aikaleimat ja muut vain vastauksessa käytettävät kentät eivät kuulu päivitykseen.

Päivitysskeema edellyttää kenttiä entityType, displayName, country, email ja brandRelationship. Toimijatyyppikohtaiset säännöt pätevät edelleen. Säilytä organisaation virallinen yritysnimi, verotunniste ja sen myöntäjämaa sekä osoite ja toimiala soveltuvin osin. Säilytä yksityisen elinkeinonharjoittajan tapauksessa sen sijaan asiaankuuluvat henkilönimen ja matkapuhelinyhteystietojen kentät. Käytä todellisia, ajantasaisia arvoja, älä rekisteröintiesimerkin paikkamerkkejä.

Brändin päivityksen kenttäryhmät
Kentät	Käyttöohje
displayName, email, phone	Tunnistettava brändinimi ja kelvolliset yhteystiedot. Enimmäispituudet: 255, 100 ja 20 merkkiä. Käytä puhelinnumerossa kansainvälistä muotoa, jossa maakoodin edessä on +.
street, city, state, postalCode, country	Todellinen yritysosoite, jonka tiedot ovat keskenään johdonmukaiset. Rajat: 255, 100, 20, 10 ja 2 merkkiä. Käytä tarvittaessa Yhdysvaltain osavaltioiden ajantasaisia koodeja.
entityType, companyName, ein, einIssuingCountry	Oikeudellinen identiteetti. Näiden tietojen muuttamista rajoitetaan, kun kampanjoita tai ulkoisia arviointeja on odottamassa tai käynnissä. Älä poista toimivia kampanjoita vain kiertääksesi identiteettitietoja koskevan rajoituksen.
firstName, lastName, mobilePhone, businessContactEmail	Identiteettitiedot tai vahvistuksessa käytettävät yhteystiedot silloin, kun ne soveltuvat toimijatyyppiin. Rajat: 100, 100, 20 ja 255 merkkiä.
brandRelationship, vertical	Ajantasaiset suhde- ja toimialakoodit. Suhdetta voi muuttaa enintään kerran kolmessa kuukaudessa. Portaalin tavallinen muokkauslomake ei tarjoa mahdollisuutta suhteen muuttamiseen.
website, altBusinessIdType, altBusinessId, stockSymbol, stockExchange	Soveltuvat verkkosivuston, vaihtoehtoisen yritystunnisteen ja pörssiyhtiön tiedot. Säilytä toimijan validoinnissa tarvittavat arvot.
referenceId, ipAddress	Tuetut yritysviitteen ja alkuperäisen IP-osoitteen metatiedot. Kumpikaan kenttä ei määritä tilin omistajuutta eikä toimi pyynnön idempotenssiavaimena.

Käytä ajantasaisia viestintäluetteloita koodien tarkistamiseen. Päivitysskeema ei tarjoa mock-kenttää keinoksi vaihtaa brändin ympäristöä. Käytä erillistä, tarkastettua työnkulkua testiympäristöstä tuotantoon siirtymiseen sen sijaan, että muuttaisit kyseistä lippua muokkauksen yhteydessä.

Lähetä tarkastettu korjaus

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"

Käytä tähän aiottuun päivitykseen yhtä ja samaa avainta ja säilytä pyynnön runko täsmälleen samoina tavuina. Avaimen uudelleenkäyttö muutetulla metodilla, polulla, kyselyllä tai rungolla aiheuttaa ristiriidan; myös JSON-muotoilun muuttaminen muuttaa sormenjälkeä. Käynnissä olevan pyynnön kaksoiskappale voi palauttaa tilan 409 ja otsakkeen Retry-After. Valmis pyyntö voi palauttaa uudelleen tallennetun tuloksensa, myös virheen. Säilytä pyynnön tiedot aikakatkaisua selvittäessäsi sen sijaan, että loisit automaattisesti uuden avaimen.

Tarkista tallennettu tietue ja validointitila

Onnistunut päivitys palauttaa tilan HTTP 200 ja brändin suoraan JSON-oliona ilman vanhaa v3-version status/response-käärettä. Tarkista sen brandId, hae sitten sama brändi uudelleen GET-pyynnöllä ja vertaa aiottuja kenttiä. Julkinen päivitysreitti ei hyväksy portaalin changes/version-käärettä eikä tarjoa sen optimistista samanaikaisuustarkistusta. Koordinoi samanaikaisia muokkaajia; idempotenssiavain estää saman päivityksen lähettämisen kahdesti, mutta ei toisen muokkaajan muutoksia.

Nykyinen portaali lukee brändin, säilyttää sen kirjoitettavat kentät, tarkistaa lomakkeen version ennen tallennusta ja lukee tuloksen uudelleen. Se lukitsee oikeudellisen identiteetin keskeiset kentät havaitessaan aktiivisia kampanjoita. Rekisteri voi asettaa lisärajoituksia, myös ulkoiseen arviointiin liittyviä rajoituksia, vaikka kenttä olisi ollut käytettävissä lomakkeella.

Korjattujen tietojen tallentaminen ei automaattisesti pyydä uutta identiteetin vahvistusta eikä takaa hyväksyntää. Uudelleenvahvistus on erillinen toimenpide, joka voi olla maksullinen; tarkista nykyinen tila portaalissa ja vahvista erikseen mahdollinen ilmoitettu maksu. Tavalliset brändin PUT-päivitykset eivät käynnistä erillistä rekisteröintiveloitusta nykyisessä API-palvelussa. Nykyiset kampanja-, viestintä- ja muut maksut pysyvät erillisinä.

Ratkaise virheet luomatta päällekkäistä rekisteröintiä

Lue HTTP-tila ja JSON-virhetiedot. Kun tila on 400, korjaa kyseinen kenttä tai noudata identiteettiä tai suhdetta koskevaa rajoitusta. Kun tila on 401, 403 tai 404, tarkista tunnistetiedot, sallittu lähde-IP-osoite ja tilin omistajuus. Kun tila on 429, noudata otsaketta Retry-After. Virhe 500 tai 502 voi ilmetä sen jälkeen, kun rekisteri on hyväksynyt päivityksen; säilytä mahdollinen requestId ja lue olemassa oleva tietue ennen uutta lähetystä.

Päivitysvastaus, joka ei ole tyhjä mutta on puutteellinen, voi jättää paikallisen tilannekuvan puutteelliseksi; onnistuneen vastauksen tyhjä runko voi jättää tilannekuvan vanhempia kenttiä ennalleen. Älä päättele kenttien säilymistä pelkän onnistumistilan perusteella. Lue koko brändi takaisin ja selvitä mahdolliset poikkeamat tuen kautta. Tämä ohje ei lupaa rekisterin, paikallisen välimuistin ja laskutuksen atomisia päivityksiä.