La API de usuario

La API de usuario es una API REST que obtiene, agrega y actualiza información de usuario/grupo/departamento.

Autenticación de usuario

La API de REST de usuario requiere autenticación de contraseña, con las claves y los valores adecuados establecidos en el encabezado de la solicitud.

Prioridad de autenticación

La prioridad de la autenticación es la siguiente.

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

Autenticación de token de API

La autenticación de token de API es un método de autenticación que utiliza un token de API generado en el Administración del sistema Configuración. Para incluir el token de API en las solicitudes de API, agréguelo a los encabezados de cada solicitud de la siguiente manera:

• Nombre del encabezado: Authorization
• Valor del encabezado: Bearer USER_API_TOKEN

Reemplace USER_API_TOKEN con el token real que recibió.

Por ejemplo, cuando el token de API es el siguiente:

1

cy.s.api1.eyJraWQiOiJ2MSIsInR5cCI6IkpXVCIsImFsZyI6IkhTMjU2In0.eyJyYW5kIjoiYzllZTRlZjAtZjI2Yi00N2VjLWI1ZWYtYThiNzBkMDU1ZDBkIiwiaXNzIjoiYzExNDkyOTc3IiwiZXhwIjoxNzg5MTAwMzcyfQ.M1ShkvH_HjHh-7Zl7ykRSeWZcXLbG7xzWuFDxgIidQ0

El encabezado de la solicitud será el siguiente:

1
2
3

{
  "Authorization": "Bearer cy.s.api1.eyJraWQiOiJ2MSIsInR5cCI6IkpXVCIsImFsZyI6IkhTMjU2In0.eyJyYW5kIjoiYzllZTRlZjAtZjI2Yi00N2VjLWI1ZWYtYThiNzBkMDU1ZDBkIiwiaXNzIjoiYzExNDkyOTc3IiwiZXhwIjoxNzg5MTAwMzcyfQ.M1ShkvH_HjHh-7Zl7ykRSeWZcXLbG7xzWuFDxgIidQ0"
}

Autenticación de contraseña

La autenticación de contraseña es un método de autenticación que utiliza el nombre de usuario y la contraseña de un usuario. Para usar la autenticación de contraseña, agréguela a los encabezados de la siguiente manera:

• Nombre del encabezado: X-Cybozu-Authorization
• Valor de encabezado: Un BASE64 codificado LOGIN_NAME:PASSWORD

Por ejemplo, cuando el nombre de inicio de sesión es "Kintone" y su contraseña es "developer", BASE64 codifique "Kintone:developer" y configúrelo en el encabezado de la siguiente manera:

1
2
3

{
  "X-Cybozu-Authorization": "S2ludG9uZTpkZXZlbG9wZXI="
}

Autenticación de sesión

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.

Método 1: Usando kintone.api()

Al ejecutar la API REST de Kintone desde un código JavaScript, se puede utilizar la autenticación de sesión.

Para obtener más información sobre el método de solicitud de API REST de Kintone, consulte el siguiente artículo:
Solicitud de API REST de Kintone

kintone.api() no se puede usar con API que cargan o descargan archivos.

Método 2: Agrega el X-Requested-With y use la API Fetch del navegador web o XMLHttpRequest

Agréguelo a los encabezados de la siguiente manera:

• Nombre del encabezado: X-Requested-With
• Valor del encabezado: XMLHttpRequest o cadenas que no están vacías

Por ejemplo, cuando el valor es XMLHttpRequest, configúrelo en el encabezado de la siguiente manera:

1
2
3

{
  "X-Requested-With": "XMLHttpRequest"
}

Para obtener más información sobre el X-Requested-With , consulte el siguiente artículo:
X-Requested-With

Además de la X-Requested-With , los tokens CSRF son necesarios cuando se utiliza la autenticación de sesión con POST／PUT／DELETE métodos. Consulte la siguiente documentación para obtener más detalles sobre la recuperación de un token CSRF:
Get CSRF Token

Autenticación básica (heredada)

Advertencia

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

Si su entorno Kintone ha establecido la función de seguridad de autenticación básica, agregue Autorización en el encabezado de la solicitud, con la cadena Basic y un nombre de inicio de sesión y contraseña codificados en BASE64 de la autenticación básica como valor.
Si el nombre de inicio de sesión de autenticación básica es "chocolate" y la contraseña de autenticación básica es "pudding", lugar "Basic " en el valor, seguido de un BASE64 codificado "Chocolate:pudín" de la siguiente manera:

1

Authorization: Basic Y2hvY29sYXRlOnB1ZGRpbmc=

Encabezados de solicitud

Estos encabezados de solicitud se utilizan para la API de REST.

Solicitud de URI

Respuestas

Códigos de estado HTTP

El código de estado HTTP 200 indica que la solicitud se realizó correctamente.
Si se produce un error en la solicitud, se devolverá un código de estado distinto de 200 y una respuesta de error.

Respuesta de error

Un objeto con las siguientes propiedades se devuelve en formato JSON.

LLAVE	VALOR
code	El código del error, para especificar el tipo de error que es.
id	El identificador del error.
message	El mensaje de error. El idioma del mensaje variará en función de la configuración de idioma del usuario de Kintone utilizado para la autenticación. Cambiar a un idioma de visualización diferente

Ejemplo de respuesta de error

1
2
3
4
5

{
  "code": "CB_IJ01",
  "id": "1505999166-897850006",
  "message": "Invalid JSON string."
}

Uso de la API de JavaScript para ejecutar la API de usuario

La solicitud de API de REST de Kintone se puede utilizar para ejecutar la API de usuario.

Para obtener más información sobre el método de solicitud de API REST de Kintone, consulte el siguiente artículo:
Solicitud de API REST de Kintone

Notas

Encabezado X-HTTP-Method-Override

• Agrega el X-HTTP-Method-Override para evitar el error de URI de solicitud demasiado grande que se produce cuando el URI de solicitud supera los 4 KB. Todas las API de usuario admiten este encabezado.
• Si un GET de una API de usuario se envía mediante el método de solicitud de la API de REST de Kintone y la longitud del URI supera los 4 KB, el X-HTTP-Method-Override se agregará automáticamente y la solicitud se enviará como un POST pedir. Esto permite que las solicitudes de API de usuario con URI largos se ejecuten sin errores.