v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Registrar Webhook Com Token - JWT

A API realiza a configuração de um webhook através de token (JWT), para recebimentos dos gatilhos disparados pela Celcoin, informando sobre os débitos de um veiculo. Com isso garantiremos uma maior segurança e confiabilidade nas trocas de mensagem do produto.

Para mais informações de como realizar a implementação dessa API criamos esse artigo

Ao realizar a configuração da url a Celcoin irá realizar uma requisição em seu endpoint para validar se ele funciona, retornando 200, vamos apresentar sucesso, caso contrário vamos avisar que um retorno inesperado aconteceu.

Para atualização da URL será necessário repetir a etapa de registro.

post/vehicledebtsapi/v1/webhook/registerWithToken

Request body

urlstring required

URL cliente para recebimento de notificações via WebHook

url_tokenstring required

Endereço do serviço para geração do token

client_idstring required

Identificação única para integração com a plataforma

client_secretstring required

O tipo de conteúdo que será enviado para o endereço do serviço de token. Ex:. application/json ou application/x-www-form-urlencoded

token_typestring required

Tipo do token. Ex:. Bearer

grant_typestring required

Usado em cenários de refresh token. Ex:. client_credentials

token_fieldstring required

Nome do campo do token no retorno da requisição de geração para armazenamento interno.

handlesstring[]

Objeto para identificação de algum processo interno. Ex: Produto, Escopo do Projeto, Equipe, Serviço e etc..

Response

200

messagestring

errorCodestring

Example response

{
  "message": "Nova URL atualizada com sucesso",
  "errorCode": "000"
}