Mudanças e suporte
Versão e histórico de alterações
A especificação OpenAPI desta documentação informa a versão 1.0.1. Este projeto atualmente não publica um histórico de versões da API ou notas de cada alteração para consumidores. Consulte o /openapi.json do ambiente usado pela integração para obter a especificação vigente, inclusive parâmetros, modelos e respostas.
Descontinuação e migração
Não há prazo para encerramento de versões. Em caso de migração ou atualização, haverá aviso formal pelos canais de comunicação estabelecidos entre a Suitable e a empresa que emitiu o acesso. Antes de atualizar uma integração:
- Compare a especificação OpenAPI atual com a usada pela integração.
- Revise alterações em parâmetros, modelos, códigos de resposta e comportamento dos endpoints utilizados.
- Valide a alteração no ambiente de testes com dados e credenciais de teste.
- Planeje a publicação da atualização depois de validar o fluxo completo.
Se uma rota estiver marcada como obsoleta na especificação, siga as informações publicadas para ela. Na ausência de prazo ou instrução de migração, confirme o plano com o atendimento da Suitable antes de depender de uma data de encerramento.
Suporte
Para esclarecer uma alteração, obter orientação de migração ou relatar problemas no uso da API, entre em contato através do canal de atendimento da Suitable já utilizado pela sua empresa, por WhatsApp ou por dentro do sistema Suitable, ou peça o contato ao responsável que forneceu as credenciais da integração. Você também pode entrar em contato através do botão flutuante na documentação.