Passos para disponibilizar uma API através do Conecta

Fornecedor do Serviço:

  1. A API deve estar disponível na internet através de https;

  2. Deve ser disponibilizada a documentação do serviço;

  3. Deve existir um ambiente não produtivo para que possamos testar a integração;

  4. Devem ser disponibilizadas credenciais de acesso, caso existam, para os diversos ambientes, desenvolvimento, homologação e produção;

  5. Caso a integração seja através de autenticação mútua, o certificado que foi fornecido pelo time do Conecta deve ser cadastrado para que possa ocorrer o consumo do serviço;

  6. Deve ser informada a capacidade máxima suportada pelo serviço (quantidade de requisições suportada por segundo);

  7. Deve ser definido o canal de comunicação com o suporte para que sejam informados possíveis problemas de indisponibilidade e/ou dúvidas durante a integração;

  8. Inserir a API no catálogo do Conecta.

Time Conecta

  1. Implementar um Adapter para integrar com a API que fornecerá o serviço de forma a atender os requisitos abaixo:

    • Padronizar o serviço disponibilizado como um REST (suportado pelo API Manager);
    • Padronizar códigos de erros conforme demais serviços disponibilizados pelo Conecta;
    • Realizar transformações necessárias para serviços que não tenham o dado com o formato pronto para o consumo;
    • Disponibilizar composição de serviço em um único serviço REST com dados que estejam disponíveis em serviços fornecedores distintos.

  2. Subscrever o Adapter construído no API Manager do Conecta;

  3. Cadastrar o órgão que está fornecendo o serviço como órgão fornecedor no Portal de Gestão;

  4. Criar uma documentação Swagger do serviço disponibilizado para os consumidores terem como referência de uso no padrão Conecta;

  5. Definir o “Rate Limit” de acesso simultâneos para o serviço disponibilizado.

Recomendação

Para o adequado funcionamento da comunicação com a aplicação, recomendamos confiar o certificado raiz atual do Let's Encrypt, o ISRG Root X1. Este certificado pode ser encontrado em: https://letsencrypt.org/pt-br/certificates/