Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mivicall.com/llms.txt

Use this file to discover all available pages before exploring further.

A API Mivicall vive sob o prefixo /v1/. Esta major version é estável e suportada indefinidamente.

​
O que é breaking

Consideramos breaking change:
  • Remover endpoint
  • Renomear field na resposta
  • Alterar tipo de field (string → int)
  • Alterar comportamento default
  • Apertar validação (rejeitar payloads que antes passavam)
  • Mudar URL ou path params
Estas mudanças resultam em nova major version (/v2/) e a anterior continua activa por 18 meses mínimo.

​
O que NÃO é breaking

  • Adicionar novo endpoint
  • Adicionar field opcional à resposta
  • Adicionar enum value (clientes devem default para casos não conhecidos)
  • Adicionar novo evento webhook
  • Adicionar header de resposta
  • Performance / latência
Estas mudanças acontecem em qualquer release sem aviso. Sejam liberais no que aceitam, conservadores no que enviam (Postel’s Law).

​
Deprecation policy

Quando um endpoint é deprecated:
  1. Anunciado no changelog + email aos accounts com integrações activas
  2. Header Sunset: <date> em todas as responses do endpoint
  3. Header Deprecation: true
  4. Minimum 12 meses até remoção efectiva
Exemplo de header: 
HTTP/1.1 200 OK
Deprecation: true
Sunset: Sat, 13 May 2027 23:59:59 GMT
Link: <https://docs.mivicall.com/api-reference/replacement-endpoint>; rel="successor-version"

​
Status experimental

Endpoints sob /v1/experimental/... podem mudar sem aviso. Não usar em produção. Útil para early feedback de features em desenvolvimento.

​
Mudanças à formato de webhook

Eventos webhook seguem mesma política:
  • Adicionar fields ao payload: não-breaking (sejam liberais)
  • Adicionar tipos de eventos: não-breaking (filtrem o que não conhecem)
  • Remover fields ou eventos: breaking → versão nova + aviso 12 meses

​
Subscrever a changelog

  • Email subscriber: ✉️ hello@mivicall.com com assunto “API Changelog Subscribe”
  • RSS: https://docs.mivicall.com/changelog/rss.xml (em construção)
  • GitHub releases: https://github.com/mivicall/api-changelog/releases (público)