Cuando se hacen solicitudes con las API de Sunshine Conversations, la autenticación es necesaria para verificar la identidad de la persona que llama. Se puede usar Basic authentication (Autenticación básica) o JSON Web Tokens (JWTs) (Tokens Web JSON (JWT)) para verificar la identidad de la persona. Ambos métodos requieren una clave API. La clave API se crea en la página API de conversaciones.
El acceso a la página API de conversaciones está incluido en el plan Zendesk Suite Professional y planes superiores. Es necesario tener activado el espacio de trabajo de agente de Zendesk para poder ver la página. Hay paquetes de complementos adicionales si se requieren más usuarios activos por mes (MAU) o más notificaciones. Si desea más información, consulte Acerca de los complementos de Zendesk Suite.
Este artículo contiene las siguientes secciones:
Acerca de las claves API
Una clave API identifica y autentica una aplicación o un usuario y está compuesta de tres partes.
- La ID de la aplicación identifica la cuenta de Zendesk.
- La ID de clave junto con la clave secreta son las credenciales utilizadas para autenticar los JWT y las llamadas de API.
- La clave secreta es la contraseña de autenticación.
Con la Autenticación básica, se pueden hacer solicitudes usando una clave API directamente. La ID de la clave es el nombre de usuario y el secreto es la contraseña.
Con los JWT, los tokens se firman con una clave API, y luego se usan para la autenticación con la API. La ID de la clave se incluye en el encabezado de JWT como la propiedad kid, mientras que el secreto firma el JWT.
Las claves API no son tan seguras como los tokens de autenticación. Asegúrese de seguir las mejores prácticas para manejar las credenciales de manera segura cuando vaya a usar una clave API en producción.
Si desea más información acerca de la autenticación de Sunshine Conversations, consulte API Authentication.
La clave API de Sunshine Conversations es diferente que las claves de autenticación de mensajería. Las claves de autenticación de mensajería se utilizan para firmar credenciales que autentican a los usuarios finales usando los SDK de Zendesk. La clave API aquí es para las llamadas de servidor a servidor y proporciona acceso a las API públicas de Sunshine Conversations que admiten el ámbito de app.
Crear y compartir las ID y la clave API
Un administrador de Zendesk debe crear una clave API y compartirla con el desarrollador. Se pueden almacenar hasta 10 claves.
Para crear y compartir una clave API
-
En el Centro de administración, haga clic en
Aplicaciones e integraciones en la barra lateral y seleccione API > API de conversaciones.
Nota: Es necesario tener un plan Zendesk Suite Professional o superior para ver esta ventana. - Haga clic en Crear clave de API.
Si está creando su primera clave, este botón aparecerá en la parte inferior de la página; si ya ha creado una clave anteriormente, aparecerá en la esquina superior derecha.
- Ingrese un nombre identificador para la clave en el cuadro de diálogo Crear nueva clave y luego haga clic en Siguiente.
- En el cuadro de diálogo Copiar secreto compartido, haga clic en Copiar para cada ID y clave secreta para guardarlas en el portapapeles y luego haga clic en Siguiente.
Volverá a la ventana de la API, donde la nueva clave aparece en la lista.
Si genera una nueva clave pero ya ha alcanzado su límite de 10 claves, aparecerá una notificación que le indica que debe borrar las claves no utilizadas.
Para borrar una clave no utilizada
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y seleccione API > API de conversaciones.
- Pase el puntero del mouse por encima de la clave que desea borrar, luego haga clic en el menú de opciones (
) y seleccione Borrar. - Para confirmar la acción, haga clic en Borrar.