O que é o B3 for Developers?
O B3 for Developers é uma plataforma no qual disponibilizaremos todas as APIs da B3.
Essa plataforma é composta por informações sobre o produto como a documentação técnica que inclui os métodos das APIS e a taxonomia.
Quem pode consumir as APIs do B3 for Developers?
Nossas APIs são exclusivamente destinadas ao consumo de clientes B2B. Não oferecemos acesso direto às APIs para pessoas físicas. Estamos focados em atender empresas e organizações que desejam aproveitar ao máximo nossas soluções tecnológicas.
Se você representa uma empresa e deseja obter acesso às nossas APIs, entre em contato com o seu Gerente de Relacionamento (RM) através do site de clientes da B3. Nossa equipe dedicada está pronta para ajudá-lo(a) a entender melhor as possibilidades oferecidas por nossos serviços e a auxiliá-lo(a) durante todo o processo de integração.
O que você vai encontrar no B3 for Developers?
Este é um espaço dedicado a disponibilização de todas as informações necessárias sobre nossas APIs. Aqui você encontrará documentações completas e atualizadas, as quais o ajudarão a integrar e utilizar nossos serviços de forma eficiente. Ex:
- Visão Geral - Documentação de negócio sobre o objetivo da API e fluxos de negócio.
- Regras e Boas Práticas - Regras e boas práticas relacionadas ao bom funcionamento das APIs.
- HOST - Endereço host de CERTIFICAÇÃO e PRODUÇÃO para acesso as APIs.
- Modelo de Autenticação - Documentação sobre o modelo de segurança adotado para acessar a API.
- Change Log - Histórico com as evoluções de cada versão da API, juntamente com a data de certificação e produção
- Swagger - Arquivo JSON com a especificação da API
Como eu acesso as APIs da B3?
1. Garanta que você tenha o pacote de acesso B3.
2. Consulte a documentação e escolha os endpoints que deseja acessar.
3. Escolha um API client de sua preferência e siga os passos de autenticação e consuma as APIs.
O que é API?
A sigla API tem como origem o termo Application Programming Interface, o que é comumente traduzido para português com Interface de Programação de Aplicação. As APIs tem como objetivo expor através de algum padrão uma funcionalidade de uma aplicação. Ou seja é um conjunto de estratégias que permitem que uma determinada aplicação disponibilize uma funcionalidade para outras aplicações de maneira segura e padronizada.
O que são métodos?
Métodos são as ações permitidas dentro de uma API.
Existe alguma restrição de linguagem para se integrar com a APIs B3?
Não. Qualquer linguagem que possibilite a implementação de chamadas a APIs REST pode ser utilizada.
Como funciona identificação do usuário na API?
As informações que estão no pacote de acesso são utilizadas para identificar o usuário na B3. Por isso, é de extrema importância que sejam armazenadas em local seguro e que apenas pessoas autorizadas tenham acesso.
- Para exemplos e definição do modelo de autenticação adotado, consulte a documentação oficial da API
Para obter informações referente ao Sandbox acesse o link
Quando uma API é chamada, diferentes códigos de status HTTP são retornados para indicar se a requisição foi bem-sucedido ou se falhou. Veja abaixo a lista.
| Códigos HTTP | Descrição | Descrição detalhada |
|---|---|---|
| 400 | Bad Request | Falha na requisição. Algum campo enviado incorretamente. |
| 401 | Unauthorized | Sem permissão - Falha de autorização |
| 403 | Forbidden | A requisição se perdeu entre a aplicação e o servidor |
| 404 | Not Found | Rota não encontrada |
| 422 | Unprocessable Entity | Erro de negócio, algum campo com informação de negócio incompatível. |
| 429 | Too Many Requests | Excesso de requisições em um curto espaço de tempo |
| 500 | Internal Server Error | Dificuldade no processamento da requisição |
| 503 | Service Unavailable | Serviço fora do ar |
| 504 | Gateway Timeout | Gateway excedeu o tempo de resposta |
Fale com um especialista
A B3 conta com um time especializado para tirar todas as suas dúvidas sobre APIs.
