InstitucionalBlogService DeskStatus Page

Alteração de configuração

stable

Suggest Edits

Este endpoint permite alterar a chave pública (publicKey), a chave privada (privateKey) e/ou a URI do endpoint de um webhook configurado pelo parceiro.

Requisição

Requisição HTTP

PATCH 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/{id}'

curl --request PATCH \
			--url 'https://api-mtls.sandbox.bankly.com.br/webhooks/configurations/e77748a7-dcd2-4f22-9242-096420dc6fa3' \  
			--header 'Content-Type: application/json' \
			--header 'api-version: 1.0' \  
			--header 'Authorization: Bearer [token]' \  
			--data-raw '{ 
			    "privateKey": "NTRlNzM0NGMtNTdjMC00MjQ4LThiZTEtM2ZhMDg4NzcwZTA5", 
			    "publicKey": "MGE4NDIwM2ItNjU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJj", 
			    "uri": "https://webhook.site/3635f9f2-e837-41d2-j929-f7f1198120d6" 
			}

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

ScopeDescrição
webhook.writeConcede acesso para criar ou atualizar um webhook.

Cabeçalhos (Headers)

NomeDescrição
api-versionObrigatório. Versão da API. Atualmente estamos na versão 1.0.
AuthorizationObrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

No path desta requisição envie o seguinte campo:

NomeTipoDescrição
idpathObrigatório. id do webhook, que pode ser obtido na consulta de todas as configurações de webhooks.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

NomeTipoDescrição
privateKeystringObrigatório. Chave aleatória gerada pelo parceiro em base64, que somente o Bankly e o dono da chave conhecem.
publicKeystringObrigatório. Chave aleatória gerada pelo parceiro e que é enviada pelo Bankly nos cabeçalhos dos eventos de webhook.
uristringObrigatório. URI da API fornecida pelo parceiro para o recebimento dos eventos.
{ 
    "privateKey": "NTRlNzM0NGMtNTdjMC00MjQ4LThiZTEtM2ZhMDg4NzcwZTA5", 
    "publicKey": "MGE4NDIwM2ItNjU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJj", 
    "uri": "https://webhook.site/3635f9f2-e837-41d2-j929-f7f1198120d6" 
}

🚧

Importante

Mesmo que só uma das informações seja alterada, os três campos do body devem ser enviados com seus respectivos valores.

Resposta (Response)

O status code 200 indicará que a alteração foi realizada com sucesso.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

NomeTipoDescrição
dataobjectObjeto que contém os dados da configuração de webhook alterada.
data.idstringValor em UUID v4 que identifica o webhook.
data.namestringNome que o assinante deu para identificar o evento.
data.contextstringContexto do evento.
data.eventNamestringNome do evento.
data.uristringURI de recebimento dos eventos.
data.publicKeystringChave aleatória gerada pelo parceiro e que é enviada nos cabeçalhos dos eventos de webhook.
linksarray of objectsLista de links de próximos estados válidos da entidade/recurso.
links.urlstringURLs que podem ser utilizadas em um próximo estado da entidade.
links.relstringDescrição de como a URL se relaciona com o recurso atual.
links.methodstringTipo de verbo que deve ser utilizado para acessar a URL.
{
   "data": {
      "id": "b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
      "name": "TED_CASH_IN_TESTE",
      "context": "Ted",
      "eventName": "TED_CASH_IN_WAS_CLEARED",
      "uri": "https://webhook.site/3635f9f2-e837-41d2-a929-f7f1198120d8",
      "publicKey": "MGE4NDIwM2ItlmU5Yi00Zjk0LWE5NmEtNWIwMDdiOGVjMjJj"
   },
   "links": [
      {
         "url": "https://api-mtls.sandbox.bankly.com.br/webhooks/b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
         "rel": "get_webhook",
         "method": "GET"
      },
      {
         "url": "https://api-mtls.sandbox.bankly.com.br/webhooks/b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
         "rel": "update_webhook",
         "method": "PATCH"
      },
      {
         "url": "https://api-mtls.sandbox.bankly.com.br/webhooks/b933d415-9a9f-4e01-bd72-038ceb9fcfd0",
         "rel": "delete_webhook",
         "method": "DELETE"
      }
   ]
}

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status codeCódigoMensagemDescrição
404NOT_FOUNDConfiguration not found.Configuração não encontrada.
409WEBHOOK_CONFIGURATION_ALREADY_EXISTSThis configuration already exists.Essa configuração já existe.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated about 2 months ago