Documentação da API
Informações sobre como usar a API Survio
Comecemos
A integração do Survio com seus sistemas internos pode ser feita via API. Aqui está um guia rápido para você começar.
Survio fornece uma API para recuperar automaticamente dados de vários recursos. Esses dados podem ser usados para análise posterior ou implementação do processo. Você pode, por exemplo, enviar uma pesquisa de satisfação para seus clientes e fazer com que a Survio envie suas respostas automaticamente para o seu CRM ou qualquer ferramenta de BI para monitorar e avaliar os dados. Isso dá à administração da empresa a oportunidade de tomar medidas rápidas e apropriadas ou planejar consistentemente a longo prazo.
A Survio API segue o padrão Open API e o esquema está disponível para download.
Recursos
Atualmente, a API fornece acesso a apenas um recurso: respostas individuais.
Uso da API
A solicitação da API é feita usando o protocolo HTTP para hospedar “https://api2.survio.com/v2/”. No entanto, para ler os dados, você precisa obter credenciais.
Para executar solicitações, você precisa de autorização, que é feita por meio do token da API. O token é enviado no cabeçalho HTTP. O formato deste tipo de cabeçalho é o seguinte:
Authorization: Bearer <token>
Um exemplo da solicitação para obter respostas será assim:
Example request
O token é gerado especificamente para sua conta, então você só pode acessar os dados dentro de sua conta. O token não tem data de expiração, mas pode ser revogado mediante solicitação.
Para gerar um token, entre em contato com nosso atendimento ao cliente.
Qualquer pessoa com o token pode acessar os dados da sua conta por meio da API no modo somente leitura. Embora não seja possível excluir ou danificar os dados, recomendamos que você mantenha o token em um local seguro para evitar uso indevido. É possível desativar o token atual a qualquer momento e gerar um novo, se necessário.
Você pode encontrar informações mais detalhadas sobre cada endpoint de API na referência.
Cada recurso contém a URL, um método de solicitação, um esquema de solicitação e um esquema de resposta.
Paginação e filtros
Cada recurso que lista registros fornece no máximo 30 resultados por solicitação. Os resultados são organizados em ordem decrescente, começando com a última entrada. Se você exceder o número de 30 resultados, poderá usar um parâmetro GET:
?page=<page number>
para exibir páginas individuais com resultados subsequentes.
A numeração das páginas começa com "0", o que na prática significa que
“?page=0” displays the first page,
“?page=1” displays the second page,
“?page=2” displays the third page etc. until the request returns no result.
Cada recurso também permite a aplicação de diversos filtros para especificar resultados. Você pode escolher entre
data → filtrar os resultados por uma data específica
de - para → filtra os resultados por um intervalo de tempo definido
tempo de conclusão → filtra os resultados pela quantidade de tempo necessária para concluir a pesquisa
Você pode, por exemplo, obter um registro das respostas recebidas após uma determinada data usando o seguinte formato:
?submitted[after]=<time>Também é possível encadear filtros para definir um intervalo de tempo específico, por exemplo:
?submitted[after]=<time>&submitted[before]=<time>
limites de taxa
O principal objetivo dos limites de taxa é garantir uma operação confiável da API, disponibilidade constante de dados e prevenção de abuso de dados, para que você tenha todas as informações necessárias ao seu alcance a qualquer momento. Esses limites referem-se apenas ao número de 1.000 solicitações HTTP por hora por usuário.
Você tem comentários?
Antes de ir para a referência da API, agradecemos qualquer feedback que nos ajude a melhorar a experiência do usuário e a facilidade de uso da API Survio. Se você encontrar algum bug ou problema na API, não hesite em nos contatar.