Fluxo de Integração Via API

A seguir apresentamos o fluxo de integração via API, considerando sua versão mais atual. As ilustrações mostram quais endpoints devem ser utilizados em cada etapa

A documentação que descreve, especificamente, como a API do Pre-matching foi projetada encontra-se na ferramenta Swagger, apresentada na seção Documentação da API deste documento, na qual também é possível encontrar o link para consulta ao seu conteúdo e a versão mais atual da API. Também nesta documentação estão descritas as diferenças entre as versões descontinuadas.

Fluxo de operações definitivas simplificado

Fluxo de operação compromissada sem quebra de lote

Fluxo de operação compromissada com quebra de lote

Nota 3: Na imagem acima o sentido das setas indica de onde parte a ação, ou seja, de quem é a responsabilidade em acompanhar o andamento dos negócios. Nota 4: Os códigos de erros apresentados nas seções a seguir estão descritos no final deste documento.

Lançar negócio

Para que seja lançado um negócio via API no Pre-matching, deve ser utilizado o endpoint POST/api/{versao}/negocios, considerando as informações descritas na seção que detalha o fluxo

Os seguintes erros são previstos para o lançamento:

  • Operação definitiva: 001, 002, 003, 004, 006, 007, 008, 009, 011, 035, 049, 050, 064, 999.
  • Operação compromissada: 001, 002, 003, 004, 008, 009, 011, 027, 035, 049, 050, 999.

Buscar negócio

Para buscar um negócio via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/negocios/{id}, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a busca: 001, 002, 999.

Buscar negócios

Para buscar uma lista de negócios via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/negocios, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a busca de negócios: 001,002, 003, 999.

Cancelar negócio

Para que seja cancelado um negócio via API no Pre-matching, deve ser utilizado o endpoint PUT /api/{versao}/negocios/{id}/cancelar, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para o cancelamento: 001, 002, 011, 012, 013, 014, 020, 035, 045, 999.

Concluir negócio

Para que seja cancelado um negócio via API no Pre-matching, deve ser utilizado o endpoint PUT /api/{versao}/negocios/{id}/concluir, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a conclusão:

  • Operação definitiva: 001, 002, 011, 035, 999.
  • Operação compromissada: 001, 002, 011, 020, 033, 034, 035, 999.

Alterar negócio

Para que seja alterado um negócio via API no Pre-matching, deve ser utilizado o endpoint PUT /api/{versao}/negocios/{id}, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a conclusão:

  • Operação definitiva e compromissada: 001, 002, 011, 013, 014, 020, 035, 049, 050, 052, 999.

Associar negócios

Para que seja associado um negócio via API no Pre-matching, deve ser utilizado o endpoint POST /api/{versao}/associacoes, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a associação:

  • Operação definitiva: 001, 002, 011, 013, 014, 020, 035, 036, 037, 038, 039, 040, 041, 042, 044, 046, 047, 048, 066, 067, 070, 999.

Buscar associação

Para buscar um negócio via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/associacoes/{id}, considerando as informações descritas na seção que detalha o fluxo.

  • Operação definitiva: 001, 002, 999.

Remover associação

Para que seja removida uma associação entre dois negócios via API no Pre-matching, deve ser utilizado o endpoint DELETE /api/{versao}/associacoes/{id}, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a remoção da associação:

  • Operação definitiva: 001, 011, 013, 014, 020, 035, 043, 999.

Buscar negócios associados

Para buscar uma lista de negócio associados a um determinado negócio via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/negocios/{id}/associacoes, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a busca:

  • Operação definitiva: 001, 002, 999.

Permitir intermediação sem associação na plataforma

Para indicar que um negócio com intermediação não terá uma associação no Pre-matching, deve ser utilizado o endpoint PUT /api/{versao}/negocios/{id}/permitir-intermediacao-sem-associacao, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a busca:

  • 001, 002, 011, 020, 046, 054, 068, 069, 071, 999.

Nova requisição de especificação

Para realizar uma nova requisição de especificação via API no Pre-matching, deve ser utilizado o endpoint POST /api/{versao}/especificacoes, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a requisição de especificação:

  • Operação definitiva: 001, 002, 011, 013, 014, 015, 016, 017, 018, 019, 020, 023, 035, 040, 041, 044, 042, 047, 053, 058, 064, 065, 999.
  • Operação compromissada: 001, 002, 006, 007, 011, 013, 014, 015, 016, 017, 018, 019, 020, 023, 029,030, 035, 053, 055, 056, 057, 058, 060, 065, 999.

Buscar especificação

Para buscar uma especificação via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/ especificacoes /{id}.

Os seguintes erros são previstos para a busca: 001, 002, 999.

Buscar especificações

Para buscar uma lista de especificações via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/ especificacoes, considerando as informações descritas na seção que detalha o fluxo

Os seguintes erros são previstos para a busca: 001, 002, 011, 999.

Confirmar especificação

Para confirmar uma especificação via API no Pre-matching, deve ser utilizado o endpoint PUT /api/{versao}/ especificacoes /{id}/confirmar, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a confirmação de definitiva: 001, 002, 011, 013, 014, 020, 022, 024, 026, 028, 035, 999.

Alterar minha especificação

Para alterar uma especificação via API no Pre-matching, deve ser utilizado o endpoint PUT /api/{versao}/especificacoes/{id}, considerando as informações descritas na seção que detalha o fluxo.

  • Operação definitiva: 001, 002, 011, 013, 014, 015, 016, 017, 019, 020, 025, 026, 035, 040, 041, 042, 044, 047, 051, 065, 999
  • Operação compromissada: 001, 002, 006, 007, 011, 013, 014, 015, 016, 017, 020, 025, 026, 035, 051, 059, 065, 999.

Alterar quebra de lote de lastro

Para alterar uma quebra de lote de lastro via API no Pre-matching, deve ser utilizado o endpoint PUT /api/{versao}/especificacoes/quebra-lote-lastro, considerando as informações descritas na seção que detalha o fluxo.

Os seguintes erros são previstos para a alteração:

  • Operação compromissada: 001, 002, 011,013, 014,020, 025, 029, 035, 057, 058, 061,062, 063, 999

Buscar requisição de especificação

Para buscar uma requisição de especificação via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/especificacoes/requisicoes/{id}

Os seguintes erros são previstos para a busca: 001,002, 011, 999.

Buscar requisições de especificações

Para buscar uma lista de requisição de especificações de um negócio via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/especificacoes/requisicoes.

Os seguintes erros são previstos para a busca: 001,002, 011, 999.

Buscar minhas requisições de especificações

Para buscar uma lista das minhas requisições de especificações via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/especificacoes/requisicoes.

Os seguintes erros são previstos para a busca: 001,002, 011, 999.

Cancelar requisição de especificação

Para cancelar uma requisição de especificação via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/especificacoes/ requisicoes /{id}/cancelar.

Os seguintes erros são previstos para o cancelamento: 001,002, 011, 020, 021, 035, 999.

Buscar comandos

Para buscar uma lista de comandos via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/comandos.

Os seguintes erros são previstos para a busca: 001,002, 999.

Buscar eventos

Para buscar uma lista de eventos via API no Pre-matching, deve ser utilizado o endpoint GET /api/{versao}/eventos.

Os seguintes erros são previstos para este endpoint: 001, 002, 008, 999.

Demais endpoints

Os demais endpoints, descritos na documentação, serão detalhados posteriormente conforme a evolução da plataforma

Voltar para Pre-matching
Undefined