Migração da v2

Aprenda a migrar com segurança da API v2 para v3

Migrando de v2 para v3

O SurveyNinja API v3 é a versão principal atual. Esta seção ajuda os desenvolvedores que já usam a API v2 a migrar com segurança para a v3 e entender o que mudou.

A tabela completa de mudanças e todos os exemplos estão na seção ## Migration from v2 to v3 do arquivo api_v3.md .

Principais mudanças

  • Nova URL base:
    /api/v2/service → /api/v3/service
  • GET /quiz (lista de pesquisas): v3 adiciona pastas e campos adicionais na resposta.
  • Paginação: alterada para os parâmetros padrão page / per_page para a maioria dos endpoints.
  • Novos endpoints: /user.
  • Novos endpoints de exportação e relatórios: exportação de respostas e relatórios para CSV/XLSX/PDF/Word, dados adicionais de relatórios e links de relatórios públicos.

Etapas práticas de migração

  1. Atualize a URL base de /api/v2/service para /api/v3/service.
  2. Verifique quais endpoints v2 você usa e encontre seus equivalentes em v3 na documentação (pesquisas, respostas e relatórios primeiro).
  3. Se você usava paginação, mude para os parâmetros page / per_page onde necessário.
  4. Comece a usar as novas funcionalidades conforme precisar: códigos promocionais, exportação, dados adicionais de relatórios, integrações.
  5. Mantenha um link para a documentação arquivada da v2 se precisar de tempo para uma migração gradual.

O arquivo API_V2_ARCHIVE.md contém um breve resumo da v2, e api_v3.md contém a lista completa de endpoints da v3 e um mapeamento dos cenários principais.