Versionamento da API
Como funciona o versionamento da API pública da KivoSign.
Visão geral
A KivoSign versiona a API pública para poder lançar recursos novos, corrigir bugs e fazer outras mudanças sem quebrar as integrações existentes.
v2.A versão fica na URL. Por exemplo, a URL base da v2 é https://app.kivosign.com.br/api/v2.
Podemos fazer mudanças na API sem trocar o número da versão. Sempre tentamos evitar mudanças que quebrem compatibilidade, mas às vezes elas são necessárias. Nesses casos, aumentamos o número da versão e descrevemos as mudanças nas notas de versão.
Também podemos descontinuar recursos ou endpoints. Quando isso acontecer, avisaremos nas notas de versão, com o prazo de remoção.
Documentos, modelos e envelopes
A KivoSign unificou documentos e modelos em um único recurso chamado envelope. Novas integrações devem criar documentos e modelos pelos endpoints /envelope/*. Os endpoints POST /document/create e POST /template/create (incluindo as variantes /beta) estão descontinuados em favor de POST /envelope/create.
Veja Migrando para a API de envelopes para entender o motivo e ver exemplos de migração passo a passo.
Veja também
- Migrando para a API de envelopes - Saia dos endpoints de criação de documento e modelo
- Autenticação - Guia de autenticação da API
- Limites de requisições - Detalhes dos limites da API