Generación de Tokens de Acceso a Informes para Incrustación

Esta guía explica cómo generar tokens para incrustar informes de nuestra plataforma de forma segura en tus aplicaciones o páginas web usando un iframe.

Generación de un Token de Acceso a Informes de 5 Minutos

Para incrustar un informe específico, genera un token de corta duración usando tu token de API personal.

Necesitarás:

  • Tu Token de API Personal
  • El ID del Informe, que se encuentra en la URL del informe o a través de la API

Punto Final de la API:

POST /api/reports/{report_id}/generate-token

Ejemplo: Usando cURL

curl -X POST "https://pyqueryhub.com/api/reports/REPORT_ID_HERE/generate-token" \
     -H "Authorization: Bearer YOUR_PERSONAL_API_TOKEN" \
     -H "Accept: application/json"

Explicación:

  • -X POST: Realiza una solicitud POST.
  • Authorization: Usa tu Token de API Personal.
  • Accept: Especifica que quieres JSON.

Respuesta de la API (Ejemplo)

{
  "message": "Token de acceso al informe generado con éxito.",
  "token": "shortLivedRandomStringTokenValueGeneratedByTheApi",
  "report_id": "REPORT_ID_HERE",
  "expires_at": "2025-05-20T19:15:00.000000Z",
  "view_url": "https://pyqueryhub.com/api/reports/{REPORT_ID_HERE}/view/{shortLivedRandomStringTokenValueGeneratedByTheApi}"
}
  • token: El token de acceso al informe de corta duración.
  • view_url: Usa esto en el src de tu iframe.
  • expires_at: Cuándo expira el token (5 minutos).

Si la solicitud falla (p. ej., token no válido o sin permiso), la API devuelve un error 4xx con una explicación en JSON.

{danger} Solo llama a esto en tu back-end. Mantén el Token de API en secreto

Parte 3: Usando view_url en un Iframe

Incrusta el informe usando la view_url:

<iframe src="PEGAR_LA_VIEW_URL_AQUÍ"
        width="100%"
        height="600px"
        frameborder="0"
        title="Informe Incrustado">
</iframe>

Ejemplo:

<iframe src="https://pyqueryhub.com/api/reports/REPORT_ID_HERE/view/shortLivedRandomStringTokenValueGeneratedByTheApi"
        width="100%"
        height="600px"
        frameborder="0"
        title="Nombre del Informe Incrustado">
</iframe>

⚠️ La view_url expira después de 5 minutos. Si un usuario actualiza o vuelve a visitar la página más tarde, genera un nuevo token programáticamente.

Notas Importantes

  • Seguridad: Nunca expongas tu Token de API Personal en código de cara al público. Usa lógica del lado del servidor para la generación de tokens.
  • Expiración del Token: El límite de 5 minutos mejora la seguridad. Diseña tu aplicación para manejar la actualización de tokens según sea necesario.

Si encuentras problemas, inspecciona la respuesta de la API o contacta al soporte.