Para: Administradores
Entienda lo que la API puede hacer
Descubre qué funciones pueden alcanzar una clave de administración y una clave de concentrador, por qué cada clave actúa como asistente virtual y dónde encontrar la lista técnica completa.
En este artículo2 secciones
La API permite que su propio software, como un sistema de gestión de casos, funcione en conjunto con su centro de control, sin que nadie necesite utilizar las pantallas del sistema. Se utiliza una clave APILlave Un token secreto, creado en la sección de Integración, que permite que tu propio software utilice la API del hub. para ello. Existen dos tipos de claves: una clave de administración, que se utiliza para manejar los casos y las personas dentro del panel de administración; y otra clave, que se utiliza para el trabajo dentro de los propios casos.
Cómo funciona
Dos claves, dos API’s. Cada tipo de clave corresponde a una dirección específica. Después de esa dirección, viene la identificación del centro de control al que pertenece esa clave. Esta clave es rechazada por el otro dispositivo.
| Llave | DIRECCIÓN | Lo que alcanza |
|---|---|---|
| Gestionar los aspectos clave. | https://prd-api-manage.caseactive.com/v1/<hub id>/ | Casos, quienes están involucrados en ellos, las personas y su acceso a los datos, sus roles, las etapas del proceso, búsquedas y facturas que deben ser leídas. Las importaciones se encuentran en https://prd-api-manage.caseactive.com/v1/integration/<hub id>/. |
| Tecla de acceso | https://prd-api-app.caseactive.com/v1/<hub id>/ | Todo lo que se encuentra dentro de cada caso: publicaciones y comentarios, archivos, formularios, firmas electrónicas, tareas, facturas, eventos, notas y los detalles relacionados con el caso. |
Qué cosas puede hacer una llave de administración… Solo estos. Cualquier otro llamado al API del panel de administración generará una respuesta 403. BotNotAllowedException.
- Casos: lista, creación, lectura, actualización y eliminación. Ver Crear y actualizar casos, con la opción de administrarlos.
- Miembros de casos: lista, agregar y eliminar. Consulte “Agregar y eliminar miembros de los casos utilizando una clave de gestión”.
- Personas: se puede listar, agregar, leer información sobre ellas, y también desactivar o reinstalarlas. Consulte “Agregar y actualizar usuarios con una clave de administración”.
- Roles y etapas: lea lo relacionado con los roles. Vea ¿Qué roles hay y cómo se manejan?.
- Campos personalizados: lea las páginas relacionadas con los campos de casos y usuarios. Vea Crear y actualizar casos utilizando una clave de gestión.
- Facturas: hay que leerlas. Vea “Leer facturas con una clave de gestión”.
- Buscar. Vea “Búsqueda de casos y usuarios con la opción de gestión”.
- Importaciones. Ver Ejecutar una importación con la tecla “Manage”.
Cada llave es tu Asistente Virtual. Son señales clave para que tu centro de operaciones funcione correctamente. Asistente virtualAsistente virtual Un miembro del equipo automatizado que publica mensajes de bienvenida, registros de asistencia y actualizaciones de la empresa; sus publicaciones llevan una insignia de Asistente Virtual.. Lo que se publica se muestra bajo el nombre y la insignia del Asistente Virtual. Lo que se modifica también se registra como parte de las funciones del Asistente Virtual. El Asistente Virtual está presente en todos los casos, por lo que una clave de hub puede acceder a todos los casos en ese hub. Puede realizar las tareas que permiten las funciones del Asistente Virtual; por defecto, estas son las mismas que pueden hacer el personal. En cambio, un caso cerrado solo puede ser leído por el Asistente Virtual. Una clave de hub no puede crear casos, añadir o eliminar personas, pagar facturas, ni abrir o responder consultas.
Las llaves no caducan. Son obras clave que permanecerán activas hasta que un administrador las desactive o las elimine. Limite el número de ellas a la dirección IPv4 pública de su sistema. Consulte… Restringir o revocar una clave de API.
Las páginas técnicas. Cada API publica una descripción técnica completa de sus llamadas, sin necesidad de iniciar sesión.
| Administrar claves | llave del concentrador | |
|---|---|---|
| Interactivo (Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| Referencia (ReDoc) | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| Documento OpenAPI | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
Las aplicaciones indican todas las llamadas que realizan, incluyendo muchas de las que no pueden gestionar con la clave correspondiente. La lista anterior muestra qué puede hacer una clave de gestión. Para probar una llamada en la página interactiva, seleccione Autorizar y pegue su clave.
Un hub bloqueado. Mientras que el panel de administración del hub está bloqueado después de un pago fallido, se rechaza la solicitud para acceder al mismo, con el código 403 ManageBillingInactiveException. Una clave de hub sigue funcionando hasta que el portal se convierte en de solo lectura: 14 días después del pago fallido, si aún no se ha pagado, o el día en que termina la suscripción cancelada. A partir de ese momento, la clave de hub puede seguir utilizándose, pero cualquier cambio se rechaza, con el código 403 BillingReadOnlyException, hasta que el administrador reinicia la suscripción.
Cuándo usarlo
Utilice una clave de gestión para mantener su sistema al día con otro sistema: puede crear casos, agregar clientes y asignarlos a esos casos. También puede quitar el acceso a las personas cuando se van, o cargar varias filas de datos de un archivo al mismo tiempo. Utilice una clave de gestión para trabajar dentro de los casos desde su propio software, por ejemplo, para agregar información cuando algo cambia en su sistema.
Para estar al tanto de los cambios que ocurren en tu centro de procesamiento, en lugar de tener que esperar a que se produzcan, utiliza un webhook. Ver más información sobre esto. Configurar un webhook.. Para crear una clave, vea… Cree una clave de API..