Ayuda

API para desarrolladores

Conecta tu software mediante acciones explícitas para fuentes, procesamiento, resultados y gestión. Esta guía describe la API disponible dentro de los límites documentados de esta versión. Usuario, permisos, almacenamiento y créditos siguen vinculados a la cuenta de Rapportly.

Prepara la integración en tres pasos

1. 1
   Elige usuario, entorno y permisos

   Abre Cuenta → Integraciones. Usa una clave de prueba para el simulador ficticio y otra de producción para acciones reales con datos ficticios. El administrador debe asignar solo los permisos necesarios y un presupuesto adecuado.

2. 2
   Practica la recepción y los errores

   Empieza con el simulador. Después importa los contratos de API y revisa los ejemplos sintéticos. Guarda los secretos en tu servidor; las modificaciones están desactivadas por defecto en la colección.

3. 3
   Sigue una solicitud completa

   Guarda los datos y el identificador, comprueba inicio y estado final, lee el resultado, descarga un archivo disponible y revisa el consumo. Haz esta prueba únicamente en un entorno autorizado.

Crear tu clave API

Dirección base

https://api.rapportly.io/api/rapportly/v1

La clave pertenece a un usuario

Una clave delega los permisos de un usuario. El administrador fija entorno, límite de permisos, presupuesto mensual y vencimiento. El miembro activa la clave preparada y ve el secreto una vez. Cada solicitud verifica también los permisos actuales de usuario, plan y objeto. La gestión de claves usa una sesión de usuario; las acciones de producción, una clave API. Guarda los secretos en el servidor y revoca claves perdidas en Cuenta → Integraciones. Los eventos de Zapier tienen su propio contrato.

GET https://api.rapportly.io/api/rapportly/v1/ping
Authorization: Bearer rply_<jouw_sleutel>

Usa contratos y ejemplos concretos

La OpenAPI de producción describe contratos del código y marca entradas o respuestas parciales. El inventario muestra esquemas abiertos. La colección Postman comienza con dirección inválida, claves vacías y modificaciones desactivadas. Importa para revisar y envía conscientemente datos ficticios en un entorno autorizado. La importación aún no está probada.

• Descargar la especificación OpenAPI de producción
• Descargar la colección Postman sintética
• Descargar el recorrido desde la fuente hasta la descarga
• Descargar el inventario de esquemas pendientes

Practica primero con solicitudes ficticias

Crea una clave de prueba y practica solicitudes en curso, resultados, errores y presupuesto insuficiente. El simulador usa datos fijos y no consume créditos.

1. En Cuenta → Integraciones, crea o activa una clave Test con los permisos que quieras practicar.
2. Consulta GET /test/scenarios y elige una acción de la respuesta. La lista respeta tus permisos actuales.
3. Envía POST /test/opdrachten solo con actie y scenario: succes, verwerking_mislukt, creditbudget_bereikt o toegang_geweigerd. Cada nuevo ejercicio usa su propio Idempotency-Key.
4. Guarda opdracht_id. Con bezig, consulta GET /test/opdrachten/{id} tras unos cinco segundos. Comprueba siempre el estado: HTTP200 también puede contener un fallo de procesamiento.

POST https://api.rapportly.io/api/rapportly/v1/test/opdrachten
Authorization: Bearer rply_test_<jouw_testsleutel>
Idempotency-Key: test-rapport-0001
Content-Type: application/json

{
  "actie": "rapport.start",
  "scenario": "succes"
}

El ejemplo requiere rapport.start en tu lista. Tras un problema de conexión, repite los mismos datos e Idempotency-Key.

• Descargar la guía del simulador
• Descargar la colección Postman de práctica
• Descargar la OpenAPI del simulador

Obtén solo lo necesario

Busca carpetas de clientes, conversaciones e informes accesibles. /acties muestra acciones y permisos; /gebruik, presupuesto y reservas; /verzoeken, historial técnico. Un procesamiento en curso aún no tiene resultado. Los enlaces de informes duran 15 minutos; vuelve a leer el informe para obtener otro.

Actualizar la gestión de clientes

Tu software puede modificar las plantillas de la oficina, guardar búsquedas personales, registrar una visita y crear un proceso de seguimiento. Usa los permisos de administración adecuados y confirma cada cambio. Lee primero la versión actual y conserva el mismo identificador de solicitud si se pierde la respuesta. Repetir una solicitud antigua no debe revertir un cambio más reciente. La prueba en producción verifica las búsquedas, las visitas y los procesos de seguimiento, incluida la limpieza y la revocación de claves. Las plantillas de la oficina solo se leyeron; la escritura se probó localmente y en CI. La guía descargable describe las cuatro rutas y los límites de sus pruebas.

Comparar dos versiones guardadas

Compara dos números de versión existentes del mismo campo de texto guardado de un informe o del mismo campo guardado de una conversación, sin nuevo procesamiento de IA. Este contrato se probó localmente y en CI; la prueba CRM en producción no demuestra el comportamiento de la comparación en producción. El historial que falte no se sustituye por el texto actual. Las diferencias largas se recortan a un máximo de 8000 caracteres por lado, con una indicación visible. No se comparan PowerPoint, cálculos de presupuestos, cartas de presentación ni formatos. Siguen vigentes los permisos de lectura y las condiciones de privacidad actuales.

Solicitar una estimación previa

POST /generatieplan muestra pasos y créditos previstos para informe, presupuesto o conversación. Usa gebruik:lezen. El cálculo y los ajustes de equipo coinciden con la web.

Una estimación no inicia procesos ni descuenta créditos. No es un precio máximo garantizado. Muestra incertidumbres, como costes de lectura de archivos aún desconocidos. Al iniciar se comprueban de nuevo permisos y créditos.

Descargar la guía de estimación y ejemplos

Inicia un procesamiento desde tu software

La API conecta expedientes, documentos, cargas, audio, transcripción, carpetas de clientes, estilos, resultados, workflows, Excel y mensajes dirigidos. Cada ruta mantiene sus datos, permisos, confirmaciones y controles de versión. Se aplican el procesamiento y la contabilidad de créditos existentes. La respuesta inicial confirma recepción; consulta después el estado. El inventario señala los contratos pendientes.

Crea primero un expediente

Genera y guarda un UUID. Envía PUT /dossiers/{id} solo con naam, máximo 200 caracteres. 201 significa creación; 200, repetición idéntica. El expediente pertenece al usuario y organización de la clave y no consume créditos. Datos distintos devuelven 409; un expediente inaccesible o eliminado, 404. GET /dossiers/{id} permite leer naam y klant_id con permiso de lectura.

PUT https://api.rapportly.io/api/rapportly/v1/dossiers/00000000-0000-4000-8000-000000000002
Authorization: Bearer rply_<jouw_sleutel>
Content-Type: application/json

{ "naam": "Voorbeeldproject" }

Informe, presupuesto o presentación

Empieza con dossierId y notities. tier es opcional: basis, standaard o max. Sin perfil de estilo se usa un diseño neutro. Puedes aportar stijlprofielId, klantId, bronOpnameIds y taal accesibles. El estilo debe corresponder al documento. Los presupuestos siguen la configuración empresarial y numeración segura; la API no los envía al cliente.

POST https://api.rapportly.io/api/rapportly/v1/rapporten
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-rapport-2026-0001
Content-Type: application/json

{
  "dossierId": "00000000-0000-4000-8000-000000000002",
  "notities": "Team Atlas besprak de training. Noor plant de volgende bijeenkomst op donderdag.",
  "tier": "standaard"
}

Guarda versie_id y sigue GET /rapporten/{versie_id}, también para presupuestos y presentaciones. Con estado klaar, resultaat contiene archivos disponibles: export_url para PDF, export_url_docx para Word y export_url_pptx para PowerPoint. Los enlaces duran 15 minutos. Ante mislukt, revisa procesamiento y consumo antes de iniciar automáticamente otra solicitud con una clave nueva.

Descargar el recorrido desde la fuente hasta la descarga

Subir tus ejemplos de estilo

Envía entre uno y tres archivos como conjunto completo. Rapportly aplica los mismos controles que la web. La solicitud usa el almacenamiento y los créditos del usuario vinculado.

1. Envía archivos, nombre, tipo de documento, ámbito personal o equipo, confirmación explícita e identificador fijo. Los estilos de equipo requieren administrador o responsable de equipo.
2. Guarda el identificador de recepción y consulta el estado. Recibido significa que el conjunto completo está guardado; la revisión y aprobación pueden venir después.
3. Tras una interrupción, repite exactamente la solicitud sin crear otro estilo. Las cargas incompletas se pueden repetir durante treinta días y después se limpian de forma controlada.

Descargar la guía multipart de ejemplos de estilo y errores

Conectar calendario o buzón

El usuario da personalmente su consentimiento en Google o Microsoft. Tu software sigue la solicitud y puede detener la conexión de forma explícita. Contraseñas y tokens del proveedor no aparecen en la respuesta.

Usa verbindingen:beheren para conexiones y agenda:lezen para citas. Enviar requiere además permiso de envío y una solicitud consciente.

Guarda número de solicitud, identificador y base actual. Repite exactamente una solicitud perdida; una desconexión antigua no debe eliminar una conexión posterior.

La API puede elegir el buzón predeterminado con permisos de gestión y envío. Lee primero la selección y conexión actuales. Una repetición antigua no cambia una selección posterior; los envíos existentes conservan su remitente.

Descargar pasos de consentimiento, citas, desconexión y recuperación

Resultados de conversación desde texto

Envía una transcripción de al menos cien caracteres. Usa gesprek_id para seguir el resultado. Opcionales: titel, tier, klantId y taal.

POST https://api.rapportly.io/api/rapportly/v1/gesprekken
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-gesprek-2026-0001
Content-Type: application/json

{
  "transcript": "Team Atlas bespreekt uitsluitend een fictieve oefening. Het team plant een training en verzamelt algemene voorbeeldvragen zonder klantgegevens.",
  "titel": "Kennismaking"
}

Leer variantes de idioma existentes

Lee los resultados de idiomas existentes. Las rutas de flujo de trabajo descritas para iniciar, pausar, reanudar y recuperar se probaron localmente y en CI; la prueba CRM en producción no verifica este procesamiento de idiomas. Úsalas solo en un entorno habilitado para ese fin. El usuario, la clave, la fuente y los costes originales siguen vinculados a la solicitud. Siguen siendo necesarios el estado actual de la fuente, los permisos, el presupuesto y la liquidación verificada; una fuente caducada o eliminada no autoriza un nuevo inicio. El procesamiento por lotes con un segundo idioma activado sigue bloqueado, incluso con ajustes heredados. Sigue excluida la opción de pagar para completar un único resultado de traducción que falte.

GET https://api.rapportly.io/api/rapportly/v1/gesprekken/00000000-0000-4000-8000-000000000001/taalvarianten
Authorization: Bearer rply_<jouw_sleutel>

Recibe un aviso al terminar el procesamiento

Rapportly puede enviar referencias técnicas a tu servidor. Obtén después el contenido con los permisos adecuados, sin consultar continuamente el progreso.

1. Crea un receptor HTTPS y regístralo mediante POST /webhooks con webhooks:beheren. Usa la misma clave de producción para los procesos correspondientes.
2. Verifica la firma sobre los bytes originales y guarda cada identificador de evento una sola vez. Confirma tras almacenar de forma segura el aviso y la tarea siguiente. Una repetición no debe crear otra solicitud.
3. Consulta GET /webhook-afleveringen y sus detalles. Los fallos temporales se reintentan como máximo ocho veces; puedes pedir una ronda adicional. Aceptado solo significa recibido por tu servidor: comprueba allí el procesamiento posterior.

• Descargar la guía de webhooks, límites y recuperación
• Descargar el ejemplo Node.js de verificación de firma

El simulador no envía avisos reales. Prueba tu receptor con datos ficticios y una integración de producción separada. El ejemplo verifica el aviso; tu servidor gestiona almacenamiento y acciones posteriores.

¿Qué significa un código de error?

Protege la clave y los datos de clientes

• Usa la clave solo en tu servidor, nunca en código público del navegador.
• Usa una clave por integración y revoca las antiguas.
• No incluyas claves, resultados o enlaces temporales en registros o chats públicos.
• Guarda los datos obtenidos según las reglas de acceso de tu sistema.