> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

Esta documentação objetiva-se em proporcionar uma visão técnica e detalhada das nossas APIs que possibilitam a consulta, simulação e contratação da antecipação de saque aniversário FGTS.
A BMP fornece um conjunto completo de soluções em APIs, permitindo a integração de outros sistemas com o benefício de antecipação de saque aniversário FGTS.
Nossas soluções liberam permissão aos recursos para executar:

* Busca e Simulação de saque aniversário FGTS
* Busca e Simulação de Saque Aniversário FGTS por Múltiplos Períodos
* Inclusão Proposta
* Consulta de Proposta
* Cancelamento de Proposta

As APIs estão disponíveis para serem requisitadas por meio de chamadas HTTP, e para realizar esse processo é fundamental e necessária a criação de um token de autorização, que permitirá o consumo de cada um dos serviços

<Warning>
  O passo a passo abaixo é obrigatório para entrada em produção.
</Warning>

<Steps>
  <Step title="Canal de Comunicação">
    Você como nosso parceiro será adicionado em um canal de comunicação para facilitar a interação entre todos os envolvidos no projeto.
  </Step>

  <Step title="Escopo do Projeto">
    Será realizado um alinhamento de escopo do projeto, sendo apresentado o cronograma.

    <Info>Nesta etapa conte com nossa equipe para apresentação de nossas APIs e nossos cases para uma melhor definição de seu projeto</Info>
  </Step>

  <Step title="Cadastro de Chave Pública">
    Nesta etapa será realizado o cadastro da chave pública.
  </Step>

  <Step title="Entrega das Credenciais de Homologação">
    Nesta etapa será entregue pelo nosso time as credenciais do ambiente de homologação.
  </Step>

  <Step title="Criação de JWT e Token">
    Implementar JWTs e tokens de acesso para autenticação e autorização.
  </Step>

  <Step title="Desenvolvimento Externo">
    O parceiro deve realizar a integração com nossas APIs.
  </Step>

  <Step title="Geração de Propostas por Ambiente">
    Será necessário o envio de 2 propostas, sendo elas:

    * proposta no status de liberada com os dados bancários de desembolso corretos
    * proposta no status de liberada com os dados bancários de desembolso incorretos
  </Step>

  <Step title="Homologação Interna BMP">
    Realizar testes de homologação interna para validar as integrações e funcionalidades.
  </Step>

  <Step title="Signoff">
    Obter a aprovação final de todas as áreas de BackOffice envolvidas.
  </Step>

  <Step title="Credenciamento de Produção">
    Realizar os procedimentos necessários para preparar e aprovar o sistema para a produção.
  </Step>

  <Step title="Entrega do Ambiente Produtivo">
    Transferir o sistema para o ambiente produtivo e iniciar as operações.
  </Step>
</Steps>

![](https://raw.githubusercontent.com/docs-petry/imagens/refs/heads/main/bmp-docs/kick-off/fgts.png)

## Planejamento

* A comunicação será feita pelo grupo do projeto via WhatsApp.
* Nosso horário de atendimento é das 09h às 18h de Segunda a Sexta.
* Não liberamos Credencial de Produção as sextas feiras e vésperas de feriados.
* Praticar 1 requisição por segundo (Rate Limite em Produção)

## Conclusão

Ao completar todos os passos deste checklist, a equipe responsável pode ter certeza de que o sistema está pronto para ser lançado no ambiente de produção, proporcionando uma experiência segura e eficiente para os usuários finais.