Ontwikkelaars

PUT/tcr/v2/brand/{brandId}

Werk ’n boodskaphandelsmerk by

Korrigeer sake- en kontakbesonderhede terwyl jy die bestaande registrasie behou en die valideringstatus daarvan nagaan.

Op hierdie bladsy
  1. Korrigeer ’n bestaande boodskaphandelsmerk
  2. Behou die huidige handelsmerkvelde
  3. Dien die nagegane regstelling in
  4. Gaan die gestoorde rekord en valideringstatus na
  5. Los foute op sonder om ’n duplikaat te registreer

Korrigeer ’n bestaande boodskaphandelsmerk

Werk die bestaande handelsmerk by wanneer die onderneming se kontakbesonderhede of adres verander. Behou die handelsmerk se identifiseerder; om nog ’n registrasie te skep, is nie die manier om ’n bestaande onderneming se besonderhede te korrigeer nie. Gebruik ’n geaktiveerde API-rekening oor HTTPS vanaf ’n toegelate bron-IP-adres. Die handelsmerk moet aan daardie rekening behoort.

Begin deur die huidige rekord te lees. Hou jou plaaslike kopie privaat omdat dit die onderneming se identiteits- en kontakinligting bevat.

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

Behou die huidige handelsmerkvelde

Stel brand-update.json uit die huidige rekord saam en kies slegs handelsmerkvelde waarna geskryf kan word. Behou die onderneming se identiteitsbesonderhede en ander vereiste waardes terwyl jy die beoogde regstelling aanbring. Moenie die hele GET-antwoord stuur nie: brandId, identiteits- en statusresultate, tydstempels en ander velde wat slegs in antwoorde voorkom, hoort nie in die bywerking nie.

Die bywerkingskema vereis entityType, displayName, country, email en brandRelationship. Entiteitspesifieke reëls geld steeds. Behou vir ’n organisasie die wettige maatskappynaam, belastingidentifiseerder en die land wat dit uitgereik het, adres en bedryf, waar van toepassing. Behou vir ’n eenmansaak eerder die toepaslike velde vir die persoon se naam en selfoonkontakbesonderhede. Gebruik werklike huidige waardes, nie die plekhouers uit ’n registrasievoorbeeld nie.

Veldgroepe vir handelsmerkbywerkings
VeldeHoe om dit te gebruik
displayName, email, phone’n Herkenbare handelsmerknaam en geldige kontakbesonderhede. Maksimum lengtes: 255, 100 en 20 karakters. Gebruik die internasionale telefoonnommerformaat met + en die landkode.
street, city, state, postalCode, country’n Werklike sakeadres waarvan die besonderhede met mekaar strook. Limiete: 255, 100, 20, 10 en 2 karakters. Gebruik huidige Amerikaanse staatskodes waar van toepassing.
entityType, companyName, ein, einIssuingCountryRegsidentiteit. Hierdie veranderinge word beperk wanneer veldtogte of eksterne keuring hangende of aktief is. Moenie werkende veldtogte uitvee bloot om ’n identiteitsbeperking te omseil nie.
firstName, lastName, mobilePhone, businessContactEmailIdentiteitsbesonderhede of kontakbesonderhede vir verifikasie, waar dit by die entiteitstipe pas. Limiete: 100, 100, 20 en 255 karakters.
brandRelationship, verticalHuidige verhoudings- en bedryfskodes. Die verhouding mag slegs een keer in drie maande verander word. Die portaal se gewone wysigingsvorm bied nie die moontlikheid om die verhouding te verander nie.
website, altBusinessIdType, altBusinessId, stockSymbol, stockExchangeToepaslike webwerf, alternatiewe sake-identiteitsbesonderhede en besonderhede van die openbare maatskappy. Behou waardes wat vir die entiteit se validering nodig is.
referenceId, ipAddressOndersteunde metadata vir die sakeverwysing en bron-IP-adres. Nie een hiervan bepaal rekeningeienaarskap of dien as die versoek se idempotensiesleutel nie.

Gebruik die huidige boodskapkatalogusse vir kodes. Die bywerkingskema bied nie mock as ’n manier om ’n handelsmerk se omgewing te verander nie. Gebruik die afsonderlike, nagegane werkvloei om van die toetsomgewing na produksie oor te skakel, eerder as om daardie vlag tydens ’n wysiging te verander.

Dien die nagegane regstelling in

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"

Gebruik een sleutel vir hierdie beoogde bywerking en behou die presiese grepe van die versoekliggaam. Hergebruik daarvan met ’n veranderde metode, pad, navraag of liggaam veroorsaak ’n konflik; herformatering van JSON verander ook die vingerafdruk. ’n Duplikaat van ’n versoek wat nog verwerk word, kan 409 met Retry-After teruggee. ’n Voltooide versoek kan sy gestoorde resultaat weer teruggee, insluitend ’n fout. Behou die versoekbesonderhede wanneer jy die uitkoms ná ’n uittelling uitklaar, eerder as om outomaties ’n nuwe sleutel te genereer.

Gaan die gestoorde rekord en valideringstatus na

’n Suksesvolle bywerking gee HTTP 200 en ’n direkte JSON-objek vir die handelsmerk terug, sonder die ou v3-omhulsel vir status/response. Gaan die brandId daarvan na, lees dan dieselfde handelsmerk weer met GET en vergelyk die beoogde velde. Die openbare bywerkingsroete aanvaar nie die portaal se changes/version-omhulsel nie en bied ook nie die portaal se optimistiese gelyktydigheidskontrole nie. Koördineer persone wat gelyktydig wysigings aanbring; ’n idempotensiesleutel voorkom duplikaatindiening, maar nie iemand anders se wysigings nie.

Die huidige portaal lees die handelsmerk, behou die velde waarna geskryf kan word, kontroleer die vormweergawe voordat dit stoor, en lees die resultaat weer. Dit sluit die kernvelde vir regsidentiteit wanneer dit aktiewe veldtogte vind. Die register kan bykomende beperkings oplê, insluitend beperkings op grond van eksterne keuring, selfs wanneer ’n veld op ’n vorm beskikbaar was.

Die stoor van gekorrigeerde inligting versoek nie outomaties ’n nuwe identiteitsverifikasie nie en waarborg ook nie goedkeuring nie. Herverifikasie is ’n afsonderlike handeling waarvoor ’n fooi gehef kan word; gebruik die portaal om die huidige status na te gaan en enige gekwoteerde heffing uitdruklik te bevestig. Gewone PUT-bywerkings van handelsmerke lei nie tot ’n afsonderlike registrasiedebitering in die huidige API-diens nie. Bestaande veldtog-, boodskap- en ander heffings bly afsonderlik.

Los foute op sonder om ’n duplikaat te registreer

Lees die HTTP-status en die foutbesonderhede in JSON. Vir 400, korrigeer die betrokke veld of hou by die identiteits- of verhoudingsbeperking. Vir 401, 403 of 404, kontroleer die aanmeldbesonderhede, toegelate bron-IP-adres en rekeningeienaarskap. Vir 429, volg Retry-After. ’n 500 of 502 kan voorkom nadat die register die bywerking aanvaar het; behou enige requestId en lees die bestaande rekord voordat jy weer indien.

’n Bywerkingsantwoord wat nie leeg is nie, maar wel onvolledig is, kan ’n onvolledige plaaslike momentopname laat; ’n leë liggaam in ’n suksesvolle antwoord kan ouer momentopnamevelde behou. Moenie uit ’n blote suksesstatus aflei dat velde behoue gebly het nie. Lees die volledige handelsmerk weer en los enige teenstrydigheid met die ondersteuningsdiens se hulp op. Hierdie gids belowe nie atomiese bywerkings van die register, plaaslike kas en fakturering nie.