syndication

PUT /v1/syndication/connections/{connectionId}

Rename a connection or replace its credential.

Све syndication крајње тачке

Сва документација за програмере →

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

curl -X PUT https://api.zinndigital.com/v1/syndication/connections/{connectionId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

⛔ Omitting credentials KEEPS the stored credential rather than clearing it — a customer renaming a connection must not silently delete their token. Gated on syndication.manage.

Параметри

НазивТипОбавезноШта је ово
connectionId (path)stringДа—

Тело захтева

НазивТипОбавезноШта је ово
namestringНе—
credentialsobjectНе⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Одговор

НазивТипОбавезноШта је ово
idstringДа—
channelstringДа—
namestringДаThe customer's own name for it. ⛔ name on the wire, label on the model: Field.label is DRF's own attribute and shadowing it is silent at runtime.
targetstringДаThe non-secret half — a handle, an instance, a board id.
statusstring<unverified, ready, needs_reconnect, error>Да⛔⛔ needs_reconnect is NOT a failure — the credential lapsed and only the customer can fix it. unverified means we have not looked, which is a third fact and not a quiet green.
account_refstringДаThe account the VENDOR said this credential belongs to — discovered.
verify_errorstringДаA machine code the dashboard turns into copy. Never a sentence.
verified_atstringДа—
expires_atstringДа⛔ null means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
byobooleanДаWhether the customer supplied their own developer app.
created_atstringДа—

Грешке које ова крајња тачка може вратити

401 · 403 · 404