Política de descontinuação

Sinalização na própria resposta

Toda operação descontinuada passa a responder com os cabeçalhos Deprecation e Sunset. O Sunset traz a data a partir da qual a operação deixa de funcionar. Quando existe uma operação sucessora, a resposta traz também o cabeçalho Link com rel="successor-version", apontando para ela.

Monitore esses cabeçalhos na sua integração: eles são o primeiro sinal de que uma operação que você usa vai sair do ar.

Prazo mínimo de 6 meses por operação

Entre o anúncio da descontinuação e a retirada de uma operação passam pelo menos 6 meses.

Como a descontinuação é anunciada

A MSP Works comunica a descontinuação aos administradores das empresas que têm a API pública habilitada, e registra o anúncio, com a data de retirada, no changelog.

Versão inteira

Depois que a /v2 estiver estável, a /v1 inteira continua no ar por pelo menos 12 meses. Veja a política de versionamento.

Exceção única: o relatório legado

O endpoint legado de execução de relatório, anterior à API pública, sai do ar 30 dias depois do aviso da MSP Works às empresas que o usam, com a data de desligamento no cabeçalho Sunset. Ele já exige o mesmo que o endpoint novo: a API pública habilitada ou reports:read liberado por concessão. É uma exceção única e não vale como precedente para as operações da API pública. Veja Migrar do relatório legado.