Definir o segredo do provedor

PUT

/v1/ingest/sources/{id}/secret

O segredo com que a fonte confere a assinatura do provedor, como a chave secreta do webhook no Mercado Pago ou o signing secret no Stripe. Ele entra e nunca volta pela API. Vazio ou ausente remove o segredo.

Autorização

• Bearer

Parâmetros

Parâmetros de caminho

id

obrigatório

string

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

secret

obrigatório

null | string

Exemplo^gerado

{
  "secret": "example"
}

Respostas

200

Sucesso.

Tipo de mídiaapplication/json

object

hasSecret

obrigatório

boolean

Exemplo^gerado

{
  "hasSecret": true
}

401

Chave de API ausente, inválida ou revogada.

404

A fonte não existe, ou não é deste ambiente.

422

O segredo passa de 500 caracteres.

Tipo de mídiaapplication/problem+json

object

type

null | string

title

null | string

status

null | integer | string formato: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Exemplo^gerado

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Limite de requisições por segundo do plano, somado entre todas as chaves da organização.

Headers

Retry-After

integer

Segundos até a próxima janela.