La API REST de Kintone es capaz de realizar operaciones generales de creación/recuperación/actualización/eliminación de registros de aplicaciones, recuperación de descripciones de aplicaciones y manipulación de espacios.

Consulte el siguiente artículo:
Autenticación

Estos encabezados de solicitud se utilizan para la API de REST.
No es necesario especificar encabezados de solicitud cuando se utiliza una solicitud de API de REST de Kintone. Para obtener más información, consulte el siguiente artículo:
Solicitud de API REST de Kintone

Host

El valor es {subdomain}.kintone.com:443.
Se requiere host.

Content-Type

El valor especificado depende del formato del cuerpo de la solicitud.

• Para JSON: application/json
• Para datos de varias partes: multipart/form-data

Solo es necesario cuando se envía un cuerpo de solicitud.

X-Cybozu-Authorization

login_name:password codificado en base64.
Solo es necesario cuando se utiliza la autenticación con contraseña. Para obtener más información, consulte el siguiente artículo:
Autenticación de contraseña

X-Cybozu-API-Token

El token de API de la aplicación Kintone.
Solo es necesario cuando se utiliza la autenticación de token de API. Para obtener más información, consulte el siguiente artículo:
Autenticación de token de API

X-Requested-With

XMLHttpRequest o cadenas que no están vacías.
Solo es necesario para la autenticación de sesión. Para obtener más información, consulte el siguiente artículo:
Autenticación de sesión

X-HTTP-Method-Override

El método HTTP. Especifique una de las siguientes opciones: GET / POST / PUT / DELETE.
Especificando un método HTTP en X-HTTP-Method-Override y enviando un X-HTTP-Method-Override , se ejecutará una API que corresponda al método HTTP especificado.

• El encabezado X-HTTP-Method-Override solo será válido durante un POST pedir.
• El método HTTP especificado para X-HTTP-Method-Override distingue entre mayúsculas y minúsculas.
• El Request URI Too Large El error se puede evitar especificando este método cuando el URI de la solicitud supera los 8 KB.
• Este método de encabezado está disponible en todas las rutas de la API de REST de Kintone, pero no se puede garantizar el comportamiento cuando se usa con API externas. Para obtener más información, consulte el siguiente artículo:
  Solicitudes de API externas

Encabezado X-HTTP-Method-Override

La siguiente solicitud ejecutará la siguiente API:
Obtener registros

1
2
3
4
5

curl -X POST https://sample.kintone.com/k/v1/records.json \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json'  \
  -H 'X-HTTP-Method-Override: GET' \
  -d '{ "app": 1, "query": "Updated_datetime > \"2024-08-03T09:00:00Z\"" }'

Aceptar-Idioma

El código lingüístico, p. ej.en, ja, zh, es.
Si el idioma de visualización se establece en Uso de la configuración del navegador web, la respuesta se devolverá en el idioma especificado. Especifique este encabezado solo cuando designe el idioma de visualización del resultado de la solicitud.

El cuerpo de la solicitud tiene formato JSON. La codificación de caracteres debe estar en UTF-8. Sin embargo, cuando se utiliza la API de carga de archivos, el cuerpo de la solicitud debe tener el formato multipart/form-data. Para obtener más información, consulte el siguiente artículo:
Carga de archivos

Una barra invertida \ se puede usar para escapar caracteres dentro del JSON según sea necesario.

En el caso de las rutas de API que utilizan el método GET , los parámetros de solicitud se pueden pasar a través de la URL como parámetros de consulta. Por ejemplo, para especificar un App Id de 1, los parámetros de consulta se pueden establecer de la siguiente manera:

1

/k/v1/records.json?app=1

Codificación

De acuerdo con el estándar de URL, las claves y los valores de los parámetros de consulta se codifican mediante la codificación de URL. En el ejemplo siguiente se muestra una cadena codificada de URL para "Updated_datetime > "2024-10-01T09:00:00+0900":

1

/k/v1/records.json?app=1&query=Updated_datetime+%3E+2024-10-01T09%3A00%3A00%2B0900

Parámetros de matriz

Descomponga la matriz y codifique la URL de cada elemento. En el siguiente ejemplo, se utiliza la API Get Records. El fields incluye un parámetro Record Id campo y un campo Dropdown campo. Para obtener más información, consulte el siguiente artículo:
Obtener registros

1. fields=[Record_Id,Dropdown] se descompone en elementos separados

   1	/k/v1/records.json?app=1&fields[0]=Record_Id&fields[1]=Dropdown

2. Las claves y los valores de cada parámetro están codificados en URL

   1	/k/v1/records.json?app=1&fields%5B0%5D%3DRecord_Id%26fields%5B1%5D%3DDropdown

El código de estado HTTP 200 indica que la solicitud se recibió correctamente.
Trate cualquier otro código de estado como errores. Consulte la siguiente sección para obtener más información sobre los tipos de usuarios:
Respuesta de error

Todas las API REST de Kintone incluyen los siguientes detalles en el encabezado de respuesta.

X-ConcurrencyLimit-Limit

El límite de solicitudes de API simultáneas.
El valor predeterminado es 100.

X-ConcurrencyLimit-Running

El número de solicitudes de API simultáneas en ejecución.

Acerca de la respuesta de una solicitud realizada con kintone.api()

Al usar kintone.api() para realizar solicitudes de API REST de Kintone, solo se pasa el cuerpo de la respuesta a la función de devolución de llamada. Para utilizar otros datos que no estén incluidos en el cuerpo de la respuesta, absténgase de utilizar kintone.api() y en su lugar usar otro método. Solicitud de API REST de Kintone

Se devuelve en formato JSON. La codificación de caracteres es UTF-8.
Sin embargo, la API para descargar archivos devuelve datos binarios:
Descargar archivo

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

Ejemplo de respuesta de error

1
2
3
4
5

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

Los campos relacionados con la fecha y la hora siguen los siguientes formatos.

Formato

YYYY-MM-DD

Descripción

Esto no se convierte a UTC. Se pueden utilizar los siguientes formatos de fecha:

• p. ej.. YYYY
• p. ej.. YYYY-MM
• p. ej.. YYYY-M
• p. ej.. YYYY-M-D

Si se ignora la fecha y/o el mes, se complementará con 01:

• 2024 → 2024-01-01
• 2024-08 → 2024-08-01
• 2024-8 → 2024-08-01
• 2024-8-1 → 2024-08-01

Formato

HH:MM

Descripción

Esto no se convierte a UTC.

Formato

YYYY-MM-DDTHH:MM:SSZ

Descripción

Por ejemplo 22 de agosto de 2024 07:00 PST será respondido como 2024-08-22T15:00:00Z.
Indica que la fecha y hora se expresa en UTC.
Un valor fijo para separar la fecha de la hora. Cuando se omite después de T, se considera como 00:00 UTC. Por ejemplo 2024-08-01 será respondido como 2024-08-01T00:00:00Z.
La fecha y la hora en el Obtener vistas La salida de la API está en UTC. Para obtener más información, consulte el siguiente artículo:
Obtener vistas

Formato

YYYY-MM-DDTHH:MM:SS±HH:MM o YYYY-MM-DDTHH:MM:SSZ

Descripción

Por ejemplo 22 de agosto de 2024 07:23 PST se puede solicitar como 2024-08-22T15:23:00Z o 2024-08-22T07:23:00-08:00.
Indica que la fecha y hora se expresa en UTC.
Un valor fijo para separar la fecha de la hora. Cuando se omite después de T, se considera como 00:00 UTC. Por ejemplo 2024-08-01 será respondido como 2024-08-01T00:00:00Z.
±HH:MM especifica la diferencia horaria con respecto a UTC.
Valores indicados para SS será ignorado, y será tratado como 00 Por ejemplo 2024-08-01T12:59:59Z será respondido como 2024-08-01T12:59:00Z.

• Después de las actualizaciones de Kintone, los cambios en las especificaciones, como la adición de nuevos campos y claves, se pueden aplicar a los formatos JSON de los datos de solicitud y respuesta.
• Para ver información de las operaciones de aplicación, registro, comentario y espacio, consulte los registros de auditoría. Para obtener más información, consulte el siguiente artículo:
  Comprobación de los registros de auditoría de Kintone
• El número de solicitudes de API disponibles por día es de 10.000 por aplicación. Para las API que no se cuentan como parte de los límites de llamadas a la API, consulte el siguiente enlace:
  El número de solicitudes de API disponibles por día
• Si un dominio tiene restricción de dirección IP, solo las solicitudes de API de una dirección IP aprobada se realizarán correctamente.

• 100 solicitudes simultáneas por dominio

• 10.000 solicitudes por aplicación

Para las API que no se cuentan en el número de solicitudes, consulte el siguiente artículo en el sitio de ayuda de Kintone:
El número de solicitudes de API disponibles por día

• El número máximo de registros que se pueden especificar en el archivo offset de la API Get Records es 10.000. Para obtener más información, consulte el siguiente artículo:
  Obtener registros
• El número máximo de registros que se pueden agregar, actualizar o eliminar a la vez: 100
• No agregue un gran número de filas a una sola tabla. Dependiendo de la configuración de la aplicación, la carga puede afectar el procesamiento de registros, como la visualización de registros en el archivo Vista o manipulando registros mediante la API REST.
• Al operar en Búsqueda con la API Add Record(s) y la API Update Record(s), el campo clave de la aplicación de origen de datos debe ser un Número de registro o un campo con la opción "Prohibir valores duplicados" activada.
• Si el campo clave de la aplicación de origen de datos de un Búsqueda campo es un campo Text con la opción "Calcular automáticamente" activada, el campo Búsqueda no se puede operar con API.
• Para obtener más información, consulte el siguiente artículo en el sitio de ayuda de Kintone:
  API para manipular registros de aplicaciones

• Los archivos cargados se almacenan en el área de almacenamiento temporal y se eliminan tres días después de la carga, a menos que el archivo se adjunte a un registro mediante la API Agregar registro o la API Actualizar registro.
• Los archivos almacenados en el área de almacenamiento temporal se incluyen en el uso del disco.

• El número máximo de comentarios que se pueden recuperar a la vez: 10

Para obtener más información sobre las limitaciones y el uso de la API de REST de Kintone, consulte la sección API de REST del siguiente artículo:
Lista de valores límite

Basic seguido de un código Base64 login_name:password. Solo es necesario cuando se usa la autenticación básica obsoleta, que ya no está disponible a partir de junio de 2020. Para obtener más información, consulte el siguiente artículo:
Autenticación básica