API

Autenticação

Saiba como começar a usar a API REST da BRy

Introdução

Para utilizar nossa API, é necessário um cadastro inicial em nosso portal e cadastrar uma aplicação para obter um token de acesso ao serviço desejado.

Em todas operações é necessário incluir o token de acesso no header Authorization (Bearer). Ele contém informações que identificam uma aplicação e deve ser configurado em todas as requisições HTTP. Caso não seja definido, os pedidos não serão autorizados.

Acesso Simplificado

Para ter acesso simplificado ao quickstart, acesse esta página, e preencha seus dados.
Enviaremos um e-mail para sua caixa de entrada, com o token de acesso.

Também é possível obter um novo token utilizando nosso endpoint com o client e secret enviados.

Acesso Completo

Você pode se cadastrar no portal informando seus dados para criação da conta.

No portal, você pode gerenciar aplicações pessoais ou corporativas.

Para cadastrar aplicações, você deve acessar o menu Gestão >Minhas aplicações

Após o cadastro da aplicação, é necessário emitir o client_secret (chave da API) clicando na opção emitir client_secret na tela de aplicações.

A partir desse passo, você poderá obter um access_token (token de acesso JWT) clicando na opção de emitir token.
O seu token deve ter o formato: eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJIcVFrTkVFVzJJdzNuU0JPcklDUU9K.

Também é possível solicitar o _acess_token _através de uma chamada HTTP. Mais detalhes no endpoint de autenticação.

  • O client_secret funciona como uma chave secreta, não possui validade e deve ser armazenada de forma segura na aplicação.
  • O access_token tem validade de alguns minutos e sua renovação deve ser gerenciada de forma automatizada pela aplicação através do endpoint conforme descrito no item renovar token de acesso.
  • O refresh_token tem validade de alguns minutos para ser utilizado e quando seu tempo expirar é preciso obter um novo token de acesso através da chamada HTTP para o serviço de autorização.

A sua aplicação deve verificar o tempo de expiração do access_token configurando a data com o fuso horário UTC-0.

Ajuda e suporte

Ainda precisa de ajuda?