Primeiros Passos

Crie sua conta

Para ter acesso à documentação das APIs é necessário ter uma conta de desenvolvedor no Dev Portal do Banco Original. Após aprovação da sua conta, você receberá um link para definição da sua senha e a partir daí estará pronto para começar.

Crie sua APP de Desenvolvimento

Para chamar as APIs do Banco Original é necessário criar uma APP no Portal. Na APP você encontrará as credenciais que deverá utilizar na chamada das APIs. A APP também precisa ser aprovada pelo Banco Original. Uma vez aprovada, você estará apto a fazer testes em sandbox.

Faça testes em sandbox

No ambiente de sandbox você poderá testar o funcionamento da API. Você poderá fazer chamadas e entender quais são os retornos. Os dados retornados neste ambiente são fixos e fictícios, porém, você já conseguirá desenvolver sua integração com base neste ambiente.

Solicite acesso à homologação

Após desenvolver e testar sua integração, você poderá fazer testes em um ambiente com dados mais próximos aos reais. Para isso, peça acesso para o ambiente de Homologação.

Crie sua APP de produção

Após homologar a sua integração, você deverá criar uma nova APP específica para produção. Desta forma, você terá credenciais distintas para cada ambiente. Após aprovação desta APP, sua integração estará finalizada.

Códigos de Retorno

* A API retornará os códigos HTTP Status para cada request.

Códigos de Sucesso

Código

Descrição

200

Padrão de resposta para solicitações HTTP com sucesso.

201

A solicitação foi enviada e resultou em um novo recurso.

204

O servidor processou a solicitação com sucesso e não está retornando nenhum conteúdo.

206

Conteúdo Parcial. A solicitação foi bem-sucedida e possui o body contendo os intervalos de dados solicitados, conforme descrito no header Content-Range da solicitação.

Códigos de Erro de Cliente

Código

Descrição

400

A solicitação não pode ser entregue devido à sintaxe incorreta.

401

A autenticação é obrigatória, mas falhou ou não foi fornecida.

403

Sem permissão de acesso ao recurso solicitado.

404

O recurso informado no request não foi encontrado.

412

O acesso ao recurso foi negado.

413

A solicitação é maior do que o servidor está disposto ou capaz de processar.

415

A entidade solicitada tem um tipo de mídia (midia type) que o servidor ou o recurso não tem suporte.

422

A solicitação não pode ser processada devido à semântica incorreta.

429

Foi atingido o limite de requisições por tempo.

Códigos de Erro de Servidor

Código

Descrição

500

O servidor encontrou um erro ao processar a solicitação.

502

Ocorreu um erro interno de comunicação.

504

O tempo de resposta do servidor expirou.
Português, Brasil