Skip to content
Last updated

Revogando o Acesso de uma Empresa 🔒

Visão Geral

O acesso da sua aplicação aos dados de uma empresa pode ser encerrado a qualquer momento — pela própria empresa, pelo suporte da Conta Azul ou pela sua aplicação.

Revogar é útil quando o cliente cancela o serviço, quando a integração é desativada no seu sistema ou quando você precisa encerrar uma conexão por conta própria. Depois da revogação, a empresa só volta a ser acessível com um novo consentimento.

Como Revogar

curl --location --request DELETE 'https://api-v2.contaazul.com/oauth/connections/ID_EMPRESA' \
--header 'Authorization: Bearer ACCESS_TOKEN_GERADO'

Componentes da Requisição

CampoFinalidade
ID_EMPRESAIdentificador da empresa cuja conexão será encerrada
AuthorizationAccess token válido da conexão, no formato Bearer

Sua aplicação não informa o client_id: ele é lido do próprio access token. Por isso não é possível revogar a conexão de outra aplicação.

Como obter o ID_EMPRESA

O identificador vem do endpoint de conta conectada:

curl --location 'https://api-v2.contaazul.com/v1/pessoas/conta-conectada' \
--header 'Authorization: Bearer ACCESS_TOKEN_GERADO'

O campo id_empresa da resposta é o valor que vai na URL de revogação.

Respostas

CódigoSignificado
204Acesso revogado. A resposta não tem corpo.
204O acesso já estava revogado. A operação é idempotente.
401Access token ausente, inválido ou expirado.
404Não existe conexão ativa entre sua aplicação e a empresa informada.
502A revogação não pôde ser concluída. Repita a requisição.

⚠️ O que acontece com os tokens

A revogação invalida o refresh_token imediatamente: a próxima renovação falha e não é mais possível obter novos tokens para aquela empresa.

O access_token já emitido, porém, continua válido até o fim da sua vida útil de 1 hora. Isso é uma característica do formato do token, que carrega a própria validade.

Na prática, isso significa duas coisas:

  • Chamadas feitas com um access token ainda dentro da validade continuam funcionando por até uma hora após a revogação.
  • Repetir a chamada de revogação dentro dessa janela devolve 204 novamente. Depois dela, o próprio token expira e a resposta passa a ser 401.

Como sua aplicação descobre que a empresa revogou

Quando a revogação parte da empresa ou do suporte da Conta Azul, sua aplicação descobre na próxima renovação de token, que passa a falhar com um erro específico. Veja Etapa 3 - Renovando o token de acesso para o detalhamento dos erros de renovação.

Voltando a acessar

Não há reativação automática. Para acessar novamente os dados da empresa, inicie um novo fluxo de autorização a partir da Etapa 1 e obtenha um novo consentimento.