Al utilizar las API de REST, se requerirá un encabezado de autorización. Hay dos formas principales de autenticarse cuando se utilizan las API de REST. El uso de la autenticación con contraseña permite el uso de API REST con permiso de nivel de usuario, lo que significa que el usuario autenticado deberá tener permiso para controlar la aplicación o espacio para que la API se realice correctamente. La otra opción es usar tokens de API para manipular aplicaciones con API de REST. Cada aplicación de Kintone puede crear tokens de API que funcionarán específicamente con esa aplicación. También se discutirán brevemente otros métodos de autenticación, la autenticación de sesión y la autenticación OAuth.

X-Cybozu-Authorization se coloca en el encabezado de la solicitud con un nombre de inicio de sesión y una contraseña codificados en BASE64. La codificación BASE64 se realiza en el siguiente formato: Log_in_name:password.

Por ejemplo, para un nombre de usuario de "kintone" y una contraseña de "desarrollador", BASE64 codifique "kintone:developer" y agregue esto al encabezado:

1

X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=

Cada aplicación en Kintone puede generar tokens de API a través de la configuración avanzada en el menú de configuración de la aplicación. Consulte el siguiente artículo de la Ayuda de Kintone para obtener información sobre cómo generar tokens de API desde una aplicación:
Generación de tokens de API

X-Cybozu-API-Token se coloca en el encabezado de la solicitud con el token de API. Si el token de API generado de la aplicación es "9wOomr3kpP9d1JS34Uyz72xqQ1pLI4PkcziRFTuZ", agregue lo siguiente al encabezado:

1

X-Cybozu-API-Token: 9wOomr3kpP9d1JS34Uyz72xqQ1pLI4PkcziRFTuZ

Se pueden utilizar varios tokens de API en el caso de realizar operaciones de API REST que impliquen campos de búsqueda o campos de registro relacionados. Especifique los tokens de API en el encabezado de la siguiente manera, con una coma entre ellos:

1

X-Cybozu-API-Token: 9wOomr3kpP9d1JS34Uyz72xqQ1pLI4PkcziRFTuZ,D27Dss1udL2iZtiKMniN0s30goy8gtnnEjn8Z2Ou

También se puede lograr el mismo efecto escribiendo los tokens de API en dos encabezados separados.

• Cada aplicación puede generar hasta 20 tokens de API.
• Las API REST iniciadas con tokens de API se registrarán en Kintone como operaciones realizadas por el usuario denominado Administrador.
• Tenga en cuenta que el método X-Cybozu-Authorization se priorizará sobre esta autenticación.
• La autenticación de token de API es aplicable a las siguientes API de REST de Kintone:
  • Grabar
    • Obtener registro / Agregar registro / Actualizar registro
      (Para crear/actualizar los valores de los campos de búsqueda, coloque varios tokens de API en el encabezado)
    • Obtener registros / Agregar registros / Actualizar registros / Eliminar registros
    • Obtener cursor / Agregar cursor / Eliminar cursor
    • Obtener comentarios / Agregar comentario / Eliminar comentario
    • Solicitud masiva
    • Estado de actualización
    • Estados de actualización
    • Actualizar personas asignadas
  • Archivos
    • Descargar archivo / Subir archivo
  • Aplicaciones
    • Obtener aplicación
    • Obtener campos de formulario / Agregar campos de formulario / Actualizar campos de formulario / Eliminar campos de formulario
    • Obtener diseño de formulario / Actualizar el diseño del formulario
    • Obtener vistas / Actualizar vistas (para aplicaciones sin vistas personalizadas)
    • Obtener la configuración general / Actualizar la configuración general
    • Obtener la configuración de gestión de procesos / Actualizar la configuración de administración de procesos
    • Implementar la configuración de la aplicación
    • Obtener el estado de implementación de la aplicación
    • Obtener la configuración general de notificaciones / Actualizar la configuración general de notificaciones
    • Obtener configuración de notificación por registro / Configuración de notificación de actualización por registro
    • Obtener la configuración de notificaciones de recordatorio / Actualizar la configuración de notificaciones de recordatorio
    • Obtener permisos de la aplicación / Actualizar permisos de la aplicación
    • Obtener permisos de registro / Actualizar permisos de registro
    • Obtener permisos de campo / Actualizar permisos de campo
    • Obtener la configuración del gráfico / Actualizar la configuración de Graph
    • Obtener la configuración de la acción / Actualizar la configuración de la acción
    • Obtener formulario
• Habilitar el control de acceso al departamento evitará que todos, excepto los administradores de Kintone, creen y vean tokens de API. Consulte el siguiente artículo de la Ayuda de Kintone para obtener más información sobre el control de acceso al departamento:
  Limite el acceso entre departamentos

OAuth 2.0 se puede usar para autenticar aplicaciones que se encuentran fuera de Kintone para ejecutar solicitudes de API de Kintone. OAuth 2.0 proporciona una forma segura para que la aplicación acceda a los datos de Kintone, ya que no requiere que los usuarios almacenen su usuario y contraseñas de Kintone en la aplicación.

Para obtener más información, consulte las siguientes páginas:

• OAuth 2.0
• Cómo agregar clientes de OAuth

La autenticación de sesión es un método de autenticación en el que el servidor web asigna un ID de sesión a un usuario y lo guarda como una cookie. Esta cookie se utiliza para identificar y autenticar al usuario. La autenticación de sesión solo puede ser utilizada por códigos JavaScript que se ejecutan en las páginas de Kintone. Los tokens CSRF son necesarios cuando se utiliza la autenticación de sesión con métodos POST/PUT/DELETE. Consulte la siguiente documentación para obtener más detalles sobre la recuperación de un token CSRF:
Get CSRF Token

La prioridad de la autenticación es la siguiente.

1. Autenticación con contraseña
2. Autenticación de token de API
3. Autenticación de cliente OAuth
4. Autenticación de sesión

Los usuarios invitados que ejecuten llamadas a la API solo podrán usar la autenticación de sesión. No pueden usar la autenticación con contraseña.

El lenguaje de marcado de aserción de seguridad (SAML) es una opción de autenticación que permite el inicio de sesión de Kintone a través del proveedor de identidad (IdP) de una empresa. La redirección SAML se puede omitir colocando saml=desactivado en el parámetro de la URL de inicio de sesión. Este método de omisión se puede restringir solo a la Usuarios y administradores de sistemas, si la casilla de verificación "Requerir autenticación SAML" está marcada en la configuración de autenticación SAML. Al marcar esta casilla de verificación, también se restringe el acceso a las llamadas a la API desde ciertos tipos de autenticaciones:

• Subdominios con la casilla de verificación "Requerir autenticación SAML" sin marcar:
  Las API se pueden autenticar a través de la autenticación de contraseña
  Las API se pueden autenticar a través de la autenticación de token de API
  Las API se pueden autenticar a través de OAuth
• Subdominios con la casilla de verificación "Requerir autenticación SAML" marcada:
  Las API se pueden autenticar a través de la autenticación de contraseña, pero se limitan solo a los administradores de usuarios y sistemas
  Las API se pueden autenticar a través de la autenticación de token de API
  Las API se pueden autenticar a través de OAuth

Para obtener instrucciones paso a paso sobre cómo habilitar la función de autenticación SAML, consulte el siguiente artículo de la Ayuda de Kintone:
Habilitación para usar solo la autenticación SAML al iniciar sesión

Advertencia

A partir de junio de 2020, la autenticación básica ha quedado obsoleta y ya no está disponible para su uso.

Los entornos de Kintone que utilizan la autenticación básica necesitarán un encabezado de autorización adicional. Agregue "Basic" seguido de una codificación BASE64 "Basic_log_in_name:Contraseña". Tenga en cuenta que el inicio de las API REST para aplicaciones en espacios invitados no necesitará un encabezado para la autenticación básica, ya que la autenticación básica en sí no se puede usar para espacios invitados. Si el nombre de inicio de sesión de autenticación básica es "chocolate" y la contraseña es "pudding", BASE64 codifique "chocolate:pudding" y agregue esto al encabezado:

1

Authorization:Basic Y2hvY29sYXRlOnB1ZGRpbmc=