Conecta tu propio software con Rapportly: claves, pruebas con tareas ficticias, inicio de procesos, webhooks y códigos de error.
Tareas
Preparar una clave API para una integración
Opciones: Prueba o producción · permisos · presupuesto · revocar
Abre Mi perfil, Integraciones y elige una clave independiente para la integración.
Pide al administrador que configure adecuadamente el entorno, los permisos, el presupuesto y la fecha de caducidad.
Copia el secreto cuando se muestre una única vez y guárdalo solo en la configuración del servidor de la aplicación de destino.
Prueba primero con datos ficticios; revoca una clave que no se use o se haya perdido.
Probar la API para desarrolladores de forma segura
Opciones: OpenAPI · Postman · SDK · escenarios de prueba · códigos de error
Abre Ayuda, API para desarrolladores y descarga la guía actual y la descripción OpenAPI.
Crea una clave de prueba independiente y usa el entorno de práctica sintético.
Prueba el estado, el resultado, el error y el límite de presupuesto sin datos de clientes.
Lee el contrato y los límites de versión de la ruta concreta antes de usar acciones de producción.
Explicación detallada
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.
API para desarrolladores
La base de la API existente y la extensión CRM descrita están disponibles tras un despliegue controlado dentro de los límites de la versión. La prueba CRM en producción cubre las búsquedas guardadas, el registro de visitas y los procesos de seguimiento; las plantillas de la oficina solo se leyeron. El procesamiento de idiomas del flujo de trabajo y la comparación del historial se probaron localmente y en CI, pero estas pruebas no demuestran su comportamiento completo en producción. La guía descargable detalla las pruebas exactas. Esto no equivale a una paridad funcional completa con el sitio web.
Prepara la integración en tres pasos
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
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
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.
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.
HTTP
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.
Descarga pequeños clientes sin dependencias externas para comprobar el acceso, consultar acciones y consumo, crear expedientes, subir fuentes, iniciar informes, presupuestos o presentaciones, seguir su estado y descargar los resultados. El SDK admite este subconjunto limitado de la API; no ofrece todas las funciones del sitio web. Encontrarás la instalación y los ejemplos en la guía del paquete.
Guarda la clave de API en tu servidor y registra la identidad de la solicitud antes de iniciarla. Los clientes no reintentan automáticamente las solicitudes de pago. Las descargas temporales no reciben la clave de API y se limitan a los orígenes de almacenamiento autorizados previamente. Siguen aplicándose los permisos, presupuestos y límites de disponibilidad existentes.
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.
En Cuenta → Integraciones, crea o activa una clave Test con los permisos que quieras practicar.
Consulta GET /test/scenarios y elige una acción de la respuesta. La lista respeta tus permisos actuales.
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.
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.
Practicas solicitudes, espera, repeticiones y errores. No se crean archivos reales, procesos de IA, correos ni webhooks. No demuestra calidad documental ni cobro real de créditos. Después prueba las acciones concretas de producción con datos ficticios y una clave separada. Los ejercicios caducan a los siete días.
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.
GET/ping
Comprobar la clave.
GET/gesprekken?zoek=&limiet=30&offset=0
Buscar conversaciones accesibles y recorrer los resultados.
GET/gesprekken/{id}
Leer el estado y el resultado de una conversación.
GET/rapporten/{id}
Leer el estado y el resultado de un informe.
GET/rapporten?limiet=30&offset=0
Ver informes accesibles, opcionalmente dentro de un expediente.
GET/klanten?zoek=&limiet=30&offset=0
Buscar carpetas de clientes accesibles y obtener su klantId.
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.
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.
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/rapporten
Crear un informe desde notas y fuentes disponibles.
POST/offertes
Crear un presupuesto con numeración, permisos y créditos existentes.
POST/presentaties
Crear una presentación, opcionalmente con presentatieOpties o bronRapportVersieId de un informe accesible terminado.
HTTP
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.
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.
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.
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.
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.
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.
Envía una transcripción de al menos cien caracteres. Usa gesprek_id para seguir el resultado. Opcionales: titel, tier, klantId y taal.
HTTP
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.
HTTP
GET https://api.rapportly.io/api/rapportly/v1/gesprekken/00000000-0000-4000-8000-000000000001/taalvarianten
Authorization: Bearer rply_<jouw_sleutel>
Evita solicitudes duplicadas
Guarda los datos exactos y un Idempotency-Key único por nueva solicitud. La mayoría de inicios aceptan 8–128 caracteres seguros; consentimiento y revisiones nativas exigen al menos 16. Los ejemplos usan al menos 16. Si pierdes la respuesta, repite los mismos datos y clave. Ante un conflicto de versión, vuelve a leer primero. Expedientes y cargas usan su propio UUID como límite de repetición.
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.
Crea un receptor HTTPS y regístralo mediante POST /webhooks con webhooks:beheren. Usa la misma clave de producción para los procesos correspondientes.
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.
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.
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?
400
Corrige los datos o Idempotency-Key.
401
La clave falta, es incorrecta o está revocada.
402
Faltan créditos, presupuesto o una continuación de pago válida.
403
La clave, el usuario o el plan carecen de ese permiso.
404
El objeto no existe o no es visible para este usuario.
409
Han cambiado datos, versión o solicitud. Lee primero el estado actual.
429
Espera y respeta Retry-After.
503
La fuente o el procesamiento no están disponibles de forma segura. Lee el estado y repite exactamente solo si lo permite el contrato.
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.
¿Qué partes siguen pendientes?
El inventario señala los esquemas parciales y la guía descargable describe los límites y las pruebas de cada acción. Una prueba CRM satisfactoria no demuestra el comportamiento en producción del procesamiento de idiomas del flujo de trabajo ni de la comparación del historial. El procesamiento por lotes multilingüe y la opción de pagar para completar un único resultado de traducción que falte siguen excluidos. Una clave API no otorga permisos de usuario adicionales; la comparación de documentos solo admite los campos de texto guardados que se describen.
Lo que ves puede depender de tu rol, tu plan y las integraciones de tu organización. Revisa cada borrador creado antes de compartirlo o enviarlo.