La API de DataScope te permite acceder a los datos y funcionalidades de nuestra plataforma de manera programática. Con ella, puedes automatizar tareas, integrar con otras aplicaciones y aprovechar al máximo las capacidades de DataScope.
Antes de comenzar, asegúrate de tener lo siguiente:
Clave API: Necesitarás una clave API válida para autenticar tus solicitudes. Puedes obtenerla desde tu cuenta de DataScope.
Herramienta de prueba de API: Puede ser Postman, cURL, o cualquier otra herramienta de tu preferencia.
Conocimientos básicos de HTTP: Es útil tener una comprensión básica de cómo funcionan las solicitudes y respuestas HTTP.
Paso 1: Obtener tu Clave API
Para conectarte a la API de DataScope, primero necesitas una clave API. Sigue estos pasos para obtenerla:
Inicia sesión en tu cuenta de DataScope.
Navega a la sección de Integraciones.
Busca la opción de "Clave API".
Copia la clave API generada y guárdala en un lugar seguro.
Paso 2: Realizar una Solicitud de Prueba
Ahora que tienes tu clave API, puede realizar una solicitud de prueba para asegurarte de que todo funciona correctamente.
Si todo está configurado correctamente, deberías recibir una respuesta JSON con los datos solicitados.
Por ejemplo:
Con Postman
Abre Postman: Si no tienes Postman, descárgalo e instálalo desde aquí.
Crea una Nueva Solicitud
Configura la Solicitud: por ejemplo
https://www.mydatascope.com/api/external/v4/answers?token=[id token]&form_id=[formid]
Enviar la Solicitud:
Haz clic en el botón "Send" para enviar la solicitud.
Revisa la respuesta en el panel inferior. Deberías ver los datos en formato JSON si la solicitud es exitosa.
Paso 3: Integración con tu Aplicación
Para integrar la API de DataScope en tu aplicación, puedes usar cualquier lenguaje de programación que soporte solicitudes HTTP. Como por ejemplo: Python, JavaScript (Node.js).
Paso 4: Manejo de Errores
Es importante manejar los posibles errores que pueden ocurrir al interactuar con la API. Asegúrate de revisar el código de estado de la respuesta y manejar adecuadamente los errores. Aquí hay algunos códigos de estado comunes:
200 OK: La solicitud se completó con éxito.
400 Bad Request: La solicitud es incorrecta o está malformada.
401 Unauthorized: La autenticación falló. Verifica tu clave API.
403 Forbidden: No tienes permiso para acceder a este recurso.
404 Not Found: El recurso solicitado no existe.
Preguntas frecuentes
¿Cómo obtengo el número del form id?
Debes ir al formulario que deseas vincular y obtener el ID.
ID: el Form ID, que podrá ser encontrado en la sección Configurar > Configurar App de su formulario según el image abajo:
*En este ejemplo, el Form ID es 490254.
En este caso, por ejemplo, el link sería:
https://www.mydatascope.com/api/external/v2/answers?token=b1cd93mfls9fdmfkadn23&form_id=490254
Así, obtendrás todos los formularios completados en los últimos 7 días del formulario ID 490254 en este caso, o bien puedes agregar parámetros para ampliar el rango de fecha u otros parámetros específicos que puedes encontrar en la documentación.
Conectarse a la API de DataScope es un proceso sencillo que te permite aprovechar al máximo las funcionalidades de nuestra plataforma.
----------------------------------------------------------------------------------------
Artículos Relacionados
----------------------------------------------------------------------------------------