A API da DataScope permite que você acesse os dados e funcionalidades da nossa plataforma de maneira programática. Com ela, você pode automatizar tarefas, integrar com outras aplicações e aproveitar ao máximo as capacidades da DataScope.
Antes de começar, certifique-se de ter o seguinte:
Chave API: Você precisará de uma chave API válida para autenticar suas solicitações. Você pode obtê-la em sua conta da DataScope.
Ferramenta de teste de API: Pode ser Postman, cURL, ou qualquer outra ferramenta de sua preferência.
Conhecimentos básicos de HTTP: É útil ter uma compreensão básica de como funcionam as solicitações e respostas HTTP.
Passo 1: Obtenha sua Chave API
Para se conectar à API da DataScope, primeiro você precisa de uma chave API. Siga estes passos para obtê-la:
Faça login em sua conta da DataScope.
Vá até a seção de Integrações.
Procure pela opção "Chave API".
Copie a chave API gerada e guarde-a em um lugar seguro.
Passo 2: Realizar uma Solicitação de Teste
Agora que você tem sua chave API, pode realizar uma solicitação de teste para garantir que tudo esteja funcionando corretamente.
Se tudo estiver configurado corretamente, você deverá receber uma resposta JSON com os dados solicitados.
Exemplo com Postman
Abra o Postman: Se você não tiver o Postman, baixe e instale-o a partir daqui.
Crie uma Nova Solicitação.
Configure a Solicitação: por exemplo
https://www.mydatascope.com/api/external/v4/answers?token=[id token]&form_id=[formid]
Envie a Solicitação:
Clique no botão "Send" para enviar a solicitação.
Revise a resposta no painel inferior. Você deverá ver os dados em formato JSON se a solicitação for bem-sucedida.
Passo 3: Integração com sua Aplicação
Para integrar a API da DataScope em sua aplicação, você pode usar qualquer linguagem de programação que suporte solicitações HTTP, como Python, JavaScript (Node.js).
Passo 4: Tratamento de Erros
É importante lidar com os possíveis erros que podem ocorrer ao interagir com a API. Certifique-se de revisar o código de status da resposta e tratar adequadamente os erros. Aqui estão alguns códigos de status comuns:
200 OK: A solicitação foi concluída com sucesso.
400 Bad Request: A solicitação está incorreta ou malformada.
401 Unauthorized: A autenticação falhou. Verifique sua chave API.
403 Forbidden: Você não tem permissão para acessar este recurso.
404 Not Found: O recurso solicitado não existe.
Perguntas Frequentes
Como obtenho o número do form id?
Você deve ir ao formulário que deseja vincular e obter o ID.
ID: o Form ID pode ser encontrado na seção Configurar > Configurar App do seu formulário conforme a imagem abaixo:
*Neste exemplo, o Form ID é 490254.
Neste caso, por exemplo, o link seria:
https://www.mydatascope.com/api/external/v2/answers?token=b1cd93mfls9fdmfkadn23&form_id=490254
Assim, você obterá todos os formulários preenchidos nos últimos 7 dias do formulário ID 490254, ou pode adicionar parâmetros para ampliar o intervalo de datas ou outros parâmetros específicos que você pode encontrar na documentação.
Conectar-se à API da DataScope é um processo simples que permite que você aproveite ao máximo as funcionalidades da nossa plataforma."
----------------------------------------------------------------------------------------
Artigos Relacionados
----------------------------------------------------------------------------------------