Labojiet esošu ziņojumapmaiņas zīmolu
Atjauniniet esošo zīmolu, ja mainās uzņēmuma kontaktinformācija vai adrese. Saglabājiet tā zīmola ID; esoša uzņēmuma datu labošanai nav jāveido vēl viena reģistrācija. Izmantojiet iespējotu API kontu ar HTTPS savienojumu no atļautas avota IP adreses. Zīmolam jāpieder šim kontam.
Vispirms nolasiet pašreizējo ierakstu. Glabājiet lokālo kopiju konfidenciāli, jo tajā ir uzņēmuma identifikācijas dati un kontaktinformācija.
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID" \
--output current-brand.jsonSaglabājiet pašreizējos zīmola laukus
Sagatavojiet brand-update.json no pašreizējā ieraksta, atlasot tikai rakstāmos zīmola laukus. Veicot paredzēto labojumu, saglabājiet uzņēmuma identifikācijas datus un citas obligātās vērtības. Nesūtiet visu GET atbildi: brandId, identitātes pārbaudes un statusa rezultāti, laika zīmogi un citi tikai atbildei paredzēti lauki nav jāiekļauj atjauninājumā.
Atjaunināšanas shēmā obligāti jānorāda entityType, displayName, country, email un brandRelationship. Joprojām ir spēkā konkrētajam subjekta veidam piemērojamie noteikumi. Organizācijai attiecīgajos gadījumos saglabājiet juridisko uzņēmuma nosaukumu, nodokļu identifikatoru un tā izdevējvalsti, adresi un nozari. Individuālajam komersantam tā vietā saglabājiet attiecīgos personas vārda, uzvārda un mobilā tālruņa kontaktinformācijas laukus. Izmantojiet faktiskās pašreizējās vērtības, nevis vietturus no reģistrācijas piemēra.
| Lauki | Kā tos izmantot |
|---|---|
| displayName, email, phone | Atpazīstams zīmola nosaukums un derīga kontaktinformācija. Maksimālais garums: 255, 100 un 20 rakstzīmes. Izmantojiet starptautisko tālruņa numura formātu ar + un valsts kodu. |
| street, city, state, postalCode, country | Savstarpēji saskaņoti faktiskās uzņēmuma adreses dati. Ierobežojumi: 255, 100, 20, 10 un 2 rakstzīmes. Attiecīgajos gadījumos izmantojiet aktuālos ASV štatu kodus. |
| entityType, companyName, ein, einIssuingCountry | Juridiskās identitātes dati. Šo datu izmaiņas ir ierobežotas, ja kampaņas vai ārējās pārbaudes gaida izpildi vai ir aktīvas. Nedzēsiet darbībā esošas kampaņas tikai tāpēc, lai apietu identitātes datu maiņas ierobežojumu. |
| firstName, lastName, mobilePhone, businessContactEmail | Identitātes dati vai verifikācijai paredzētā kontaktinformācija, ja tā ir piemērojama subjekta veidam. Ierobežojumi: 100, 100, 20 un 255 rakstzīmes. |
| brandRelationship, vertical | Pašreizējie attiecību un nozares kodi. Attiecības drīkst mainīt ne biežāk kā reizi trīs mēnešos. Portāla parastajā rediģēšanas veidlapā attiecību maiņa nav pieejama. |
| website, altBusinessIdType, altBusinessId, stockSymbol, stockExchange | Attiecīgajos gadījumos — tīmekļvietne, alternatīvie uzņēmuma identifikācijas dati un biržā kotēta uzņēmuma dati. Saglabājiet subjekta validācijai nepieciešamās vērtības. |
| referenceId, ipAddress | Atbalstītie uzņēmuma atsauces un avota IP adreses metadati. Neviens no šiem laukiem nenosaka piederību kontam un nedarbojas kā pieprasījuma idempotences atslēga. |
Izmantojiet aktuālos ziņojumapmaiņas katalogus kodu izvēlei. Atjaunināšanas shēmā mock nav pieejams kā veids, kā mainīt zīmola vidi. Izmantojiet atsevišķo pārskatīto darbplūsmu pārejai no smilškastes uz ražošanas vidi, nevis mainiet šo karodziņu rediģēšanas laikā.
Iesniedziet pārskatīto labojumu
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"Šim paredzētajam atjauninājumam izmantojiet vienu atslēgu un saglabājiet precīzus pieprasījuma satura baitus. Atkārtota tās izmantošana ar mainītu metodi, ceļu, vaicājumu vai saturu rada konfliktu; arī JSON pārformatēšana maina digitālo nospiedumu. Pieprasījuma, kas vēl tiek apstrādāts, dublikāts var atgriezt 409 ar Retry-After. Pabeigts pieprasījums var atkārtoti atgriezt saglabāto rezultātu, tostarp kļūdu. Noskaidrojot taimauta iznākumu, saglabājiet pieprasījuma datus, nevis automātiski ģenerējiet jaunu atslēgu.
Pārbaudiet saglabāto ierakstu un validācijas stāvokli
Sekmīgs atjauninājums atgriež HTTP 200 un tieši zīmola JSON objektu bez novecojušā v3 status/response ietvara. Pārbaudiet tā brandId, pēc tam vēlreiz nolasiet to pašu zīmolu ar GET un salīdziniet paredzētos laukus. Publiskais atjaunināšanas maršruts nepieņem portāla changes/version ietvaru un nenodrošina tā optimistisko vienlaicīguma pārbaudi. Saskaņojiet vienlaikus strādājošo redaktoru darbības; idempotences atslēga novērš atkārtotu iesniegšanu, bet neliedz citam redaktoram veikt izmaiņas.
Pašreizējais portāls nolasa zīmolu, saglabā tā rakstāmos laukus, pirms saglabāšanas pārbauda veidlapas versiju un vēlreiz nolasa rezultātu. Ja tas atrod aktīvas kampaņas, tas bloķē juridiskās identitātes pamatlaukus. Reģistrs var piemērot papildu ierobežojumus, tostarp saistībā ar ārējo pārbaudi, pat ja lauks veidlapā bija pieejams.
Labotās informācijas saglabāšana automātiski nepieprasa jaunu identitātes pārbaudi un negarantē apstiprinājumu. Atkārtota pārbaude ir atsevišķa darbība, par kuru var tikt piemērota maksa; izmantojiet portālu, lai pārskatītu pašreizējo stāvokli un skaidri apstiprinātu jebkuru norādīto maksu. Parasti zīmola PUT atjauninājumi pašreizējā API pakalpojumā neizraisa atsevišķu reģistrācijas maksas ieturējumu. Esošās kampaņu, ziņojumapmaiņas un citas maksas paliek atsevišķas.
Novērsiet kļūdas, neveidojot dublētu reģistrāciju
Izlasiet HTTP statusu un JSON kļūdas informāciju. Ja saņemat 400, izlabojiet konkrēto lauku vai ievērojiet identitātes datu vai attiecību maiņas ierobežojumu. Ja saņemat 401, 403 vai 404, pārbaudiet akreditācijas datus, atļauto avota IP adresi un piederību kontam. Ja saņemat 429, ievērojiet Retry-After. Kļūda 500 vai 502 var rasties pēc tam, kad reģistrs ir pieņēmis atjauninājumu; saglabājiet jebkuru saņemto requestId un pirms atkārtotas iesniegšanas nolasiet esošo ierakstu.
Netukša, bet nepilnīga atjaunināšanas atbilde var atstāt nepilnīgu lokālo momentuzņēmumu; tukšs sekmīgas atbildes saturs var saglabāt vecākus momentuzņēmuma laukus. Neizdariet secinājumu par lauku saglabāšanu tikai no sekmīga statusa. Vēlreiz nolasiet visus zīmola datus un novērsiet jebkuru neatbilstību ar atbalsta dienesta palīdzību. Šī rokasgrāmata negarantē atomāru reģistra, lokālās kešatmiņas un norēķinu atjaunināšanu.