Primeiros passos

Comece a usar a API do SurveyNinja em minutos

Visão geral

A API do SurveyNinja permite criar pesquisas, coletar respostas e integrar a funcionalidade de pesquisas em suas aplicações. A API segue os princípios REST e retorna dados no formato JSON.

URL base v3

https://api.surveyninja.io/api/v3/service

Toda a nova documentação abaixo descreve os endpoints da API v3. Os caminhos legados /api/service e /api/v2/service pertencem a versões anteriores da API.

Início rápido

1

Obtenha seu token de API

Faça login na sua conta do SurveyNinja e vá para Configurações → API. Crie um novo token para acessar a API.

Exemplo de token:

42|xK7mP9nQ2wL5eH8jR3vU6tY0iD4aF1bG
2

Faça sua primeira requisição

Teste sua conexão listando suas pesquisas via API v3:

GET /quiz 
curl -X GET https://api.surveyninja.io/api/v3/service/quiz \ -H "Authorization: Bearer YOUR_API_TOKEN"
3

Obtenha dados da pesquisa

Recupere informações sobre uma pesquisa específica:

GET /quiz/{id} 
curl -X GET https://api.surveyninja.io/api/v3/service/quiz/123 \ -H "Authorization: Bearer YOUR_API_TOKEN"

Baixe a versão em markdown da seção "Primeiros passos" para usar no ChatGPT / outros LLMs:

/static/api/getting-started.md
AI Markdown

O que vem a seguir?

Autenticação

Saiba mais sobre tipos de tokens e métodos de autenticação.

Saiba mais

Trabalhando com pesquisas

Explore todas as capacidades para criar e configurar pesquisas via API.

Saiba mais