Las Integraciones Privadas te permiten crear conexiones seguras y personalizadas entre tu cuenta de Ropofy y cualquier aplicación de terceros. Esta función es ideal para herramientas internas, flujos de trabajo automáticos y sistemas personalizados que requieren acceso a la API sin necesidad de crear una aplicación pública completa.
IMPORTANTE: Para una lista completa de todos los endpoints disponibles y detalles de las peticiones/respuestas, consulta la documentación oficial de la API.--- --- ---
¿Qué son las Integraciones Privadas?
Las Integraciones Privadas te permiten construir potentes integraciones personalizadas entre tu cuenta de Ropofy y cualquier otra aplicación de terceros.
Si deseas integrar tu cuenta de Ropofy con una aplicación de terceros, tienes dos opciones:
- Busca e instala la aplicación relevante desde el Marketplace de Apps
- Crea tu propia integración privada por ti mismo o con la ayuda de un desarrollador usando APIs.
Las Integraciones Privadas te ayudan a lograr la opción #2 de forma segura.
Las principales ventajas de usar Integraciones Privadas son:
- Simplicidad: Genera tokens de Integración Privada desde la configuración de tu cuenta y adminístralos fácilmente.
- Seguridad: Puedes restringir los alcances/permisos a los que un desarrollador podrá acceder en tu cuenta.
Las Integraciones Privadas están disponibles tanto para Agencias como para Subcuentas. ---
¿Cuál es la diferencia entre Integraciones Privadas y Claves API?
Las Integraciones Privadas, en resumen, son una alternativa más potente y segura respecto a las Claves API.
Integraciones Privadas | Claves API |
| Más seguro: Puedes restringir los alcances/permisos a los que un desarrollador puede acceder en tu cuenta. | Menos seguro: Un desarrollador obtiene acceso sin restricciones a todos los datos de tu cuenta. |
| Tecnología avanzada: Las Integraciones Privadas te permiten acceder a la API v2.0, que es la más avanzada. | Obsoleto: Las Claves API funcionan con la API v1.0, la cual ha alcanzado su fin de vida y ya no es mantenida. |
| Más funciones: La API v2.0 tiene APIs más potentes. | Menos funciones: La API v1.0 tiene APIs limitadas. |
¿Por qué se recomiendan los tokens de Integración Privada para nuevas credenciales?
Los tokens de Integración Privada (PIT) son el reemplazo recomendado para las antiguas claves API porque proporcionan un acceso más seguro y flexible en la gestión de permisos.
Las claves API heredadas que permanecen sin usar por más de 90 días pueden marcarse como Expiradas en la configuración. Como ya no se permite la creación de nuevas claves v1, se debe usar PIT para cualquier nueva credencial o cuando se migren integraciones antiguas a un modelo de acceso más seguro.
Si aún dependes de una clave API antigua, Ropofy recomienda migrar esa integración a un Token de Integración Privada siempre que sea posible.
---
¿Cuál es la diferencia entre Integraciones Privadas y Tokens de Acceso OAuth2?
Las Integraciones Privadas, en otras palabras, son tokens OAuth2 estáticos/fijos.
Integraciones Privadas | Tokens de Acceso |
| Generado desde la interfaz: El token de integración privada puede generarse fácilmente desde la interfaz de usuario. | Generación Programática: Los tokens de API se generan intercambiando un código de acceso OAuth por los tokens usando la API de obtención de Token de Acceso. |
| Estático/Fijo: Los Tokens de Integración Privada son estáticos/fijos y no se actualizan automáticamente salvo que los rotes desde la interfaz de usuario. | Se actualizan diariamente: Los Tokens de Acceso expiran cada día y necesitan ser renovados. |
¿Cómo uso las Integraciones Privadas?
Los tokens de Integración Privada se utilizan en el encabezado Authorization, igual que otros Tokens de Acceso.
Por ejemplo, para obtener los detalles de una ubicación, puedes usar la API Get Sub-account con el Token de Integración Privada de la Agencia en el encabezado Authorization.
curl --request GET \ --url https://services.leadconnectorhq.com/locations/ve9EPM428h8vShlRW1KT \ --header 'Accept: application/json' \ --header 'Authorization: <TU TOKEN DE INTEGRACIÓN PRIVADA>' \ --header 'Version: 2021-07-28'---
Probar una Integración Privada con llamadas API
Una vez que tu Integración Privada ha sido creada, puedes probarla enviando datos a un endpoint de la API. Necesitarás la URL del endpoint adecuada para ello.
Aquí tienes un ejemplo de cómo probar la integración agregando un nuevo contacto:
curl --request POST \
--url https://services.leadconnectorhq.com/contacts/ \
--header 'Authorization: <TU TOKEN DE INTEGRACIÓN PRIVADA>' \
--header 'Content-Type: application/json' \
--header 'Version: 2021-07-28' \
--data '{
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"phone": "+1234567890",
"locationId": "ID_UBICACIÓN"
}'
Asegúrate de:
- Reemplazar ID_UBICACIÓN con el verdadero ID de la subcuenta.
- Reemplazar el valor de Authorization con tu token de Integración Privada generado.
---
¿Cómo administro las Integraciones Privadas?
¿Quién puede crear Integraciones Privadas?
Por defecto, todos los administradores de agencias pueden crear y administrar Integraciones Privadas.
Sin embargo, puedes restringir este permiso a nivel de usuario. Para ello, navega a Configuración > Equipo > Editar al administrador de agencia específico > Roles y Permisos, y habilita/deshabilita las Integraciones Privadas para el admin.
Puedes aplicar las restricciones en dos niveles:
- Permitir al administrador de agencia ver y administrar las integraciones privadas de la agencia
- Permitir al administrador de agencia ver y administrar las integraciones privadas de subcuentas
---
¿Dónde puedo encontrar las Integraciones Privadas?
Puedes encontrar Integraciones Privadas en la configuración de la agencia. Si no la ves en la configuración, asegúrate de haber habilitado la función en Labs.
---
¿Cómo creo una nueva Integración Privada?
Nota: Puedes crear hasta 20 Tokens de Integración Privada (PIT) tanto a nivel de Agencia como de Ubicación/Subcuenta. Esto te da más flexibilidad para usar tokens separados en distintas integraciones y flujos de trabajo.
Paso 1: Haz clic en "Crear nueva Integración"
Paso 2: Asigna un nombre y una descripción a tu Integración Privada para ayudarte a ti y a tu equipo a identificar su finalidad.
Paso 3: Selecciona los alcances/permisos a los que deseas que tenga acceso la integración privada sobre tu cuenta de agencia. Asegúrate de seleccionar solo los necesarios para mejor seguridad de los datos.
Asegúrate de compartir el token solo con personas de confianza. No lo publiques de manera pública.
Nota: No olvides copiar el token generado ya que no podrás hacerlo más tarde.
---
¿Cuáles son las mejores prácticas para mantener la seguridad de mi token de integración privada?
Recomendamos rotar tus tokens de Integración Privada cada 90 días.
Así es como puedes hacerlo.
Paso 2: Haz clic en "Rotar y expirar este token después".
Paso 3: Haz clic en "Continuar" ante el mensaje de advertencia si estás seguro/a de proceder con la rotación.
Paso 4: Copia el nuevo token y actualízalo en tu aplicación de terceros.
Tendrás un plazo de 7 días en el que tanto el token viejo como el nuevo funcionarán. Después de 7 días, el token viejo expirará. En esa ventana de 7 días, tendrás la opción de:
- “Cancelar rotación” si, por ejemplo, tu desarrollador necesita más tiempo para actualizar el token en la app de terceros.
- “Expirar Ahora”, si la app de terceros ya ha sido actualizada con el nuevo token.
Nota: No olvides copiar el token generado, ya que no podrás hacerlo después.
---
¿Token comprometido?
Paso 2: Haz clic en "Rotar y expirar este token ahora".
Paso 3: Haz clic en "Continuar" ante el mensaje de advertencia si estás seguro/a de proceder con la rotación.
Paso 4: Copia el nuevo token y actualízalo en tu aplicación de terceros.
Nota: No olvides copiar el token generado, ya que luego no podrás hacerlo.
---
¿Puedo editar los permisos de la Integración Privada sin actualizar el token?
Sí, puedes editar el nombre, la descripción y los alcances/permisos de la Integración Privada en cualquier momento después de haberla creado.
Aquí te mostramos cómo hacerlo.
Paso 2: Actualiza el nombre y la descripción de la Integración Privada si lo necesitas. Haz clic en "Siguiente".
Paso 3: Si es necesario, actualiza los alcances/permisos que quieres que la integración privada tenga en tu cuenta.
Asegúrate de seleccionar solo los alcances necesarios para mejorar la seguridad de los datos. Haz clic en "Actualizar" para guardar los cambios.
Los usuarios pueden crear hasta 20 Tokens de Integración Privada (PIT) tanto a nivel de agencia como de ubicación.
Nota: Actualizar los detalles de la Integración Privada no genera un nuevo token. El token existente seguirá funcionando.---
¿Cómo elimino la Integración Privada cuando ya no la necesito?
Puedes eliminar la Integración Privada una vez que ya no utilices la app de terceros. Para hacerlo, ve a Integraciones Privadas en configuración y selecciona "Eliminar" desde el menú de tres puntos.
Comentarios
0 comentarios
Inicie sesión para dejar un comentario.