Integra Portal en tu aplicación

Ofrece evaluaciones desde tu propia interfaz y gestiona clientes, informes y créditos en tu cuenta de Portal.

Primeros pasos con la API

Crea una clave en los ajustes de desarrollador y guárdala en tu servidor. Configura PORTAL_API_BASE con la dirección del backend de Portal de tu entorno, seguida de /partner/v1.

Comprueba la conexión y los permisos de la clave. Las claves que solo permiten comprobar la conexión no sirven para los pasos siguientes.

cURL · Bash

export PORTAL_API_BASE='<PORTAL_BACKEND_ORIGIN>/partner/v1'
export PORTAL_API_KEY='<YOUR_SERVER_SIDE_KEY>'

curl --fail-with-body --request GET "$PORTAL_API_BASE/status" \
  --header "Authorization: Bearer $PORTAL_API_KEY"

Asigna cada identificador recibido a una variable de entorno Bash antes del siguiente solicitud. Estos ejemplos no se ejecutan en el navegador.

Documentación y descargas

La colección deja vacías la dirección del servidor y la clave: configúralas localmente. Generar un informe consume un crédito. Debes aportar las respuestas reales; no se rellenan automáticamente.

Guía de integración

API anterior

Referencia histórica. Sus identificadores de proveedor y rutas no corresponden a las cuentas actuales de Portal. Abrir referencia anterior

Antes de integrar

¿Dónde aparece el trabajo realizado por API?

Los clientes y sus informes aparecen en el espacio de trabajo habitual. Los cargos se muestran en Créditos. externalId es una referencia de integración y no se incluye en informes de destinatarios, correos ni PDF.

¿Se envían correos o se comparte el informe?

No. Este flujo guarda evaluaciones y genera informes para el titular de la cuenta. Compartirlos es una acción independiente en Portal.

¿Cómo funcionan los reintentos?

Reutiliza el mismo Idempotency-Key y el mismo cuerpo al crear una evaluación o un informe. Cambiar los datos con ese identificador produce un conflicto. Una evaluación incompleta devuelve 409; un saldo insuficiente, 402. Resuelve el problema y vuelve a pedir el informe con el mismo identificador.

¿Qué acceso tiene una clave de integración?

Puede actualizar clientes, gestionar evaluaciones creadas por API, leer todos los informes completos disponibles para la cuenta y consumir sus créditos. Caduca a los 90 días y puedes revocarla para cortar el acceso. No necesitas un identificador de proveedor.