API Keys

SIP Caller permite definir API Keys para integrarlo con sistemas externos. Puedes definir tantas API Keys como necesites, asignándoles un vencimiento y roles. Un sistema externo puede utilizar la API REST proporcionada por SIP Caller, autenticándose con el API Key Token generado como se describe a continuación.

Las API Keys requieren la edición Enterprise.

Roles requeridos

Para crear o editar una API Key, el usuario necesita uno de los siguientes roles:

• Administrador

Para ver una API Key, el usuario necesita uno de los siguientes roles:

• Lector de Cuenta

Crear una API Key

Para crear una API Key:

1. Ve a “Configuración” > “API Keys” y luego haz clic en “Crear”.
   
2. Especifica un nombre para la API Key.
3. Selecciona una fecha de vencimiento. Ten en cuenta que no se puede extender una vez que se haya creado la API Key.
4. Habilita los roles que deseas otorgar a las aplicaciones que usarán esta API Key. Ten en cuenta que esto no se puede cambiar una vez que se haya creado la API Key. Los roles disponibles se describen en Roles de API Key.
5. Haz clic en “Guardar” para crear la API Key.
   
6. Se mostrará un cuadro de diálogo que contiene el token para la API Key que acabas de crear. Copia el valor y guárdalo en un lugar seguro. Este token no se volverá a mostrar y no se podrá recuperar, ya que SIP Caller no lo almacenará. Si lo pierdes, deberás crear otra API Key.

Roles de API Key

Los roles asignados a una API Key definen lo que pueden hacer las aplicaciones que la utilizan. Los roles disponibles son los siguientes:

• Monitor de Colas de Central Telefónica: este rol es necesario para utilizar el módulo SIP Caller Queues Monitor y monitorear tu central telefónica en tiempo real, para las campañas que se ejecutan en modo de discador predictivo o progresivo. Puede restringirse a centrales telefónicas específicas.
• Lector de Campañas: este rol permite el acceso de solo lectura a campañas, números de campañas, listas negras, listas de contactos y reportes de campañas.
• Administrador de Campañas: este rol permite el acceso completo a campañas, números de campañas, listas negras, listas de contactos y reportes de campañas.
• Administrador de Números de Campaña: este rol permite leer, agregar y eliminar los números de una campaña. Puede restringirse a campañas específicas.
• Proveedor de Números de Campaña: este rol permite agregar números a una campaña, sin poder leerlos ni eliminarlos. Puede restringirse a campañas específicas.

Otorga a cada aplicación solo los roles que necesita. Por ejemplo, un formulario web que envía nuevos prospectos a una campaña solo necesita el rol Proveedor de Números de Campaña, restringido a esa campaña. Consulta la documentación para desarrolladores para más detalles.

Editar una API Key

Para editar una API Key:

1. Ve a “Configuración” > “API Keys” y luego haz clic en la API Key que deseas editar.
   
2. En este punto, sólo puedes editar el nombre, visualizar la fecha y hora de creación y vencimiento, y los roles asignados a la API Key. Si necesitas cambiar otros valores, deberás crear otra API Key.

Eliminar una API Key

Cuando necesites revocar el acceso de una aplicación a SIP Caller, deberás eliminar la API Key. Para ello:

1. Ve a “Configuración” > “API Keys” y, a continuación, selecciona la API Key que deseas eliminar.
2. Haz clic en el botón Eliminar y confirma la operación.