Versionamento

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

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

​

Versão atual

https://api.vendaze.com/v1/

​

Política de compatibilidade

• Novos campos opcionais são adicionados a respostas existentes
• Novos endpoints são introduzidos
• Novos parâmetros de query opcionais são adicionados
• Novos valores são adicionados a campos de tipo enum em respostas

​

O que constitui uma quebra de compatibilidade

• Remoção de um campo de resposta existente
• Alteração do tipo de um campo existente
• Remoção de um endpoint
• Mudança no significado de um código de erro existente
• Tornar obrigatório um parâmetro que era opcional
• Alteração na estrutura do objeto de resposta

​

Processo de deprecação

1. Anúncio com no mínimo 6 meses de antecedência via changelog e email para desenvolvedores registrados
2. Headers de deprecação adicionados às respostas da versão antiga:
   Deprecation: true
   Sunset: Sat, 01 Jan 2028 00:00:00 GMT
   
3. A versão antiga continua funcionando até a data de encerramento
4. Após a data de encerramento, requisições retornam 410 Gone

​

Detectar headers de deprecação

async function apiCall(url, options) {
  const res = await fetch(url, options);

  if (res.headers.get('Deprecation')) {
    const sunset = res.headers.get('Sunset');
    console.warn(`[Vendaze API] Esta versão será encerrada em: ${sunset}`);
  }

  return res.json();
}

​

Versionamento de campos adicionais

​

Changelog