Autor: Ivo Perich
Contacto: iperich@smartpaper.ai
Versión: 1.0
Fecha de Creación: 11 de noviembre de 2024
A continuación se describen los pasos necesarios para obtener un instrumento de obtención de información mediante la API de EDTECH API, a partir de un formulario inicial. Este proceso consta de 5 pasos:
Este método genera las variables iniciales necesarias para diseñar un instrumento de recolección de información, como una encuesta o entrevista, basado en el propósito, los encuestados y el contexto proporcionados.
POSThttps://edtechapi.com:7002/create_instrument_variablesBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
user_id |
String | Identificador único del usuario. |
instrument_type |
String | Tipo de instrumento a crear (encuesta, entrevista, rúbrica, escala likert, diferencial semántico,escala de rango,evaluacion de frecuencia,guía para focus group). |
purpose |
String | Propósito del instrumento de recolección de información. |
respondents |
String | Grupo de personas a quienes se aplicará el instrumento. |
context |
String | Contexto en el que se aplicará el instrumento (Ej.: Zonas rurales de la IX Región, Chile). |
perspective |
String | Enfoque o perspectiva del instrumento (Ej.: perspectiva de género). |
lang |
String | Idioma en el que se generará el instrumento (esp para español, eng para inglés). |
{
"user_id": "xxxxxxx",
"instrument_type": "encuesta",
"purpose": "Evaluación de Brecha digital",
"respondents": "Mujeres Mapuche",
"context": "Zonas rurales de la IX Región, Chile",
"perspective": "perspectiva de género",
"lang": "esp"
}
La respuesta confirmará la creación de las variables necesarias para el instrumento de recolección de información y proporcionará un job_id para continuar con los pasos posteriores.
job_id: ID de la solicitud, que identifica el proceso de creación de las variables para el instrumento de recolección.{
"job_id": 6
}
job_id obtenido en la respuesta será necesario para los pasos siguientes en el proceso de creación del instrumento de recolección.Este método permite verificar el estado de las variables generadas para el instrumento de recolección de información. Utilizando el job_id, se puede obtener la lista de variables cuando el estado esté marcado como "ready". Si el estado es "processing", las variables aún no estarán disponibles.
POSThttps://edtechapi.com:7002/get_status_instrument_variablesBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud generada con el método /create_instrument_variables. |
{
"job_id": 6
}
La respuesta incluirá el job_id, el estado de la solicitud y, si está listo, la lista de variables del instrumento de recolección de información.
job_id: ID de la solicitud.status: Estado de la solicitud, que puede tener los siguientes valores:
"processing": Las variables están en proceso de generación."ready": Las variables están listas y disponibles.instrument_variables: Lista de variables generadas si el estado es "ready", o "not_ready" si el estado es "processing"."ready"{
"job_id": 6,
"status": "ready",
"instrument_variables": "1. Acceso a dispositivos tecnológicos\n2. Conectividad a internet\n3. Frecuencia de uso de internet\n4. Nivel de habilidades digitales\n5. Uso de redes sociales\n6. Acceso a formación en tecnología\n7. Barreras culturales para el uso de tecnología\n8. Percepción de la tecnología en la vida diaria\n9. Apoyo familiar para el uso de tecnología\n10. Participación en programas de inclusión digital\n11. Uso de tecnología para actividades económicas\n12. Acceso a servicios digitales gubernamentales\n13. Uso de tecnología para la educación\n14. Percepción de seguridad en el uso de internet\n15. Influencia de la comunidad en el uso de tecnología\n16. Diferencias de género en el acceso a tecnología\n17. Impacto de la tecnología en la identidad cultural\n18. Uso de tecnología para la comunicación con familiares\n19. Acceso a contenido en lengua mapuche\n20. Percepción de la brecha digital de género\n21. Experiencias de discriminación en el acceso a tecnología\n22. Uso de tecnología para la participación comunitaria\n23. Acceso a recursos tecnológicos en la comunidad\n24. Percepción de la tecnología como herramienta de empoderamiento\n25. Necesidades tecnológicas no satisfechas\n26. Uso de tecnología para la salud y bienestar\n27. Influencia de la edad en el uso de tecnología\n28. Acceso a tecnología en espacios públicos\n29. Percepción de la tecnología en la preservación cultural\n30. Uso de tecnología para el aprendizaje de la lengua mapuche"
}
"processing"{
"job_id": 6,
"status": "processing",
"instrument_variables": "not_ready"
}
status es "processing", espera unos segundos e intenta nuevamente.status sea "ready", la lista de variables estará disponible en el campo instrument_variables.Este método permite modificar o actualizar las variables de un instrumento de recolección de información previamente generado. Se utiliza el instrument_variables_id para identificar el conjunto de variables a editar.
POSThttps://edtechapi.com:7002/update_instrument_variablesBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
instrument_variables_id |
Integer | Identificador único de las variables del instrumento a editar. |
updated_instrument_variables |
String | Nueva redacción de las variables del instrumento de recolección de información. |
{
"instrument_variables_id": 4,
"updated_instrument_variables": "\n1. Acceso a dispositivos tecnológicos\n2. Conectividad a internet\n3. Frecuencia de uso de internet\n4. Nivel de habilidades digitales\n5. Uso de redes sociales\n6. Acceso a formación en tecnología\n7. Barreras culturales para el uso de tecnología\n8. Percepción de la tecnología en la vida diaria\n9. Apoyo familiar para el uso de tecnología\n10. Participación en programas de inclusión digital\n11. Uso de tecnología para actividades económicas\n12. Acceso a servicios digitales gubernamentales\n13. Uso de tecnología para la educación\n14. Percepción de seguridad en el uso de internet\n15. Influencia de la comunidad en el uso de tecnología\n16. Diferencias de género en el acceso a tecnología\n17. Impacto de la tecnología en la identidad cultural\n18. Uso de tecnología para la comunicación con familiares\n19. Acceso a contenido en lengua mapuche\n20. Percepción de la brecha digital de género\n21. Experiencias de discriminación en el acceso a tecnología\n22. Uso de tecnología para la participación comunitaria\n23. Acceso a recursos tecnológicos en la comunidad\n24. Percepción de la tecnología como herramienta de empoderamiento\n25. Necesidades tecnológicas no satisfechas\n26. Uso de tecnología para la salud y bienestar\n27. Influencia de la edad en el uso de tecnología\n28. Acceso a tecnología en espacios públicos\n29. Percepción de la tecnología en la preservación cultural\n30. Uso de tecnología para el aprendizaje de la lengua mapuche"
}
La respuesta confirmará si la actualización de las variables del instrumento de recolección de información se realizó correctamente o si ocurrió un error.
status: Indica el resultado de la solicitud, con los siguientes posibles valores:
"done": La actualización de las variables fue exitosa."error": Ocurrió un error al intentar realizar la actualización.Caso exitoso:
{
"status": "done"
}
status es "done", la actualización fue realizada con éxito."error"contacta a soporte de Edtech API, y si es "not_found" verifica los datos proporcionados y vuelve a intentarlo, asegúrate de que el instrument_variables_id sea válido y haya sido obtenido previamente en el valor job_id entregado por el método /create_instrument_variables.Aquí tienes la documentación para el método /create_instrument:
Este método genera un instrumento de recolección de información completo, basado en las variables previamente definidas y, si es necesario, actualizadas. Se requiere el job_id obtenido en /create_instrument_variables para identificar la solicitud.
POSThttps://edtechapi.com:7002/create_instrumentBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud generada en /create_instrument_variables. |
lang |
String | Idioma del instrumento de recolección (spa para español). |
{
"job_id": 5,
"lang": "spa"
}
La respuesta contendrá un job_id que identifica el proceso de generación del instrumento de recolección de información.
job_id: ID de la solicitud, confirmando que el instrumento se ha generado correctamente.{
"job_id": 52
}
job_id obtenido en la respuesta será necesario para obtener el instrumento en el paso final"error"contacta a soporte de Edtech API, y si es "not_found" verifica los datos proporcionados y vuelve a intentarlo, asegúrate de que el job_id del input sea válido y haya sido obtenido previamente en el valor job_id entregado por el método /create_instrument_variables.Este método permite verificar el estado del instrumento de recolección de información generado con /create_instrument. Utilizando el job_id, se puede obtener el instrumento cuando el estado esté marcado como "ready". Si el estado es "processing", se recomienda intentar nuevamente después de unos segundos.
POSThttps://edtechapi.com:7002/get_status_instrumentBasic Authusername: [Tu clave de API]password: [Tu secreto de API]No se especifican encabezados adicionales.
El cuerpo de la solicitud debe enviarse en formato JSON con los siguientes parámetros:
| Parámetro | Tipo | Descripción |
|---|---|---|
job_id |
Integer | ID de la solicitud generado en /create_instrument. |
{
"job_id": 5
}
La respuesta incluirá el job_id, el estado de la solicitud y, si está listo, el instrumento de recolección de información generado.
job_id: ID de la solicitud.status: Estado de la solicitud, que puede tener los siguientes valores:
"processing": El instrumento está en proceso de generación."ready": El instrumento está listo y disponible.instrument: Contenido del instrumento generado si el estado es "ready", o "not_ready" si el estado es "processing"."ready"{
"job_id": 5,
"status": "ready",
"instrument": "Encuesta para Evaluación de Brecha Digital en Mujeres Mapuche en Zonas Rurales de la IX Región, Chile\n\n**Instrucciones:** Por favor, responda las siguientes preguntas de acuerdo a su experiencia personal. Sus respuestas son confidenciales y se utilizarán únicamente con fines de investigación.\n\n**Sección 1: Acceso y Uso de Tecnología**\n\n1. ¿Tiene acceso a algún dispositivo tecnológico en su hogar?............."
}
"processing"{
"job_id": 5,
"status": "processing"
}
status es "processing", espera unos segundos e intenta nuevamente.status sea "ready", el instrumento estará disponible en el campo instrument.