La API REST de Kintone permite controlar registros, aplicaciones y espacios desde servicios externos. En este artículo se presenta cómo usar curl para ejecutar el método Obtener API de registro desde una herramienta de línea de comandos, para recuperar datos de registro de una aplicación Kintone. Consulte el siguiente artículo para obtener más detalles sobre el Obtener API de registro:
Obtener API de registro

Un subdominio de Kintone es necesario para probar las personalizaciones e integraciones que involucran a Kintone. Una licencia de desarrollador de Kintone gratuita de un año está disponible para los miembros que se unan al Programa de desarrolladores de Kintone. Consulte la siguiente página para solicitar una licencia gratuita de desarrollador de Kintone:
Formulario de registro de licencia de desarrollador
Vuelva a este artículo cuando se haya adquirido la licencia de desarrollador. Alternativamente, puede registrarse para un entorno de prueba gratuito desde el sitio web de Kintone:
Comience su prueba gratuita de 30 días

Antes de recuperar datos de un registro de Kintone, es necesario crear una aplicación de Kintone y al menos un registro. Inicie sesión en el subdominio de Kintone con las credenciales proporcionadas al registrarse y siga estas instrucciones para preparar una aplicación.

1. En el portal, haga clic en el icono [+] del widget Aplicaciones, seleccione Servicio al cliente En el menú de la izquierda, busque el Base de datos de clientes App y haga clic en Agregar esta aplicación. Confirme el mensaje para agregar correctamente una aplicación de base de datos de clientes a su entorno de Kintone.

   

2. En el portal, haga clic en el botón Base de datos de clientes App, ubicado en el widget Aplicaciones. Si aún no hay datos en la aplicación, la lista de registros estará vacía. Haga clic en el icono [+] para comenzar a agregar datos a un nuevo registro. Al hacer clic en Salvar agregará correctamente el nuevo registro a la aplicación.

   

Este paso prepara la información necesaria para llamar a una solicitud de API de REST, preparando los parámetros de solicitud necesarios y generando un token de API desde la aplicación Kintone.

Es necesario incluir un identificador de aplicación y un identificador de registro en la solicitud. Para confirmar estos parámetros, vaya a la página de detalles del registro.

El ID de la aplicación y el ID del registro se muestran en la URL de la siguiente manera:

1

https://<SUBDOMAIN>.kintone.com/k/<App ID>/show#record=<RECORD ID>

Por ejemplo, el ID de aplicación del siguiente subdominio de Kintone llamado ejemplo es 42y el ID de registro es 8.

1

https://example.kintone.com/k/42/show#record=8

El URI de solicitud para la llamada a la API de REST tiene el formato de:

1

https://<SUBDOMAIN>.kintone.com/k/v1/record.json

Por lo tanto, para un subdominio de Kintone llamado ejemplo, la URL a la que enviar la solicitud sería:

1

https://example.kintone.com/k/v1/record.json

Agregue los parámetros de solicitud del paso anterior para formar el URI de solicitud final, en el siguiente formato:

1

https://<SUBDOMAIN>.kintone.com/k/v1/record.json?app=<APP ID>&id=<RECORD ID>

Combinando los ejemplos utilizados hasta ahora, el URI de solicitud para este ejemplo sería:

1

https://example.kintone.com/k/v1/record.json?app=42&id=8

Hay tres tipos diferentes de autenticación que se pueden usar para la API REST de Kintone: Autenticación con contraseña, Autenticación de token de APIy Autenticación de sesión. Consulte la sección Autenticación del siguiente artículo para obtener más detalles:
Descripción general de la API REST de Kintone

En este ejemplo se usará Autenticación de token de API. Para generar un token de API desde la aplicación, primero navegue hasta la aplicación de base de datos de clientes creada en el paso anterior. Desde cualquier página dentro de la aplicación, haga clic en el icono de ajustes ubicado en la esquina superior derecha de la aplicación para acceder a la configuración de la aplicación. Navegue hasta el Configuración de la aplicación y haga clic en API Token. Genere un nuevo token, haga clic en Salvary haga clic en Actualizar aplicación.

*Tenga en cuenta que el botón Actualizar aplicación mosto se puede hacer clic para que el token de API se pueda utilizar con la aplicación.

Ahora se debería haber preparado la siguiente información:

• Un ID de aplicación y un ID de registro
• Una URL de solicitud
• Un token de API

Con esta información, ensamble el comando curl para recuperar los datos de registro de la siguiente manera. El X-Cybozu-API-Token se utiliza cuando se autentica con un token de API.

1

$ curl -X GET -H 'X-Cybozu-API-Token:<API Token>' 'https://<SUBDOMAIN>.kintone.com/k/v1/record.json?app=<App ID>&id=<Record ID>'

Por ejemplo, recuperar los datos de registro 8 en la aplicación 42, con un token de API de DjsLvFiyqwDTDxJJSXnNiAuGARpPMnUIYzFluegQ, en el subdominio ejemplo, usaría el siguiente comando.

1

$ curl -X GET -H 'X-Cybozu-API-Token:DjsLvFiyqwDTDxJJSXnNiAuGARpPMnUIYzFluegQ' 'https://example.kintone.com/k/v1/record.json?app=42&id=8'

Al ejecutar este comando, la herramienta de línea de comandos responderá con los datos del registro especificado en formato JSON.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

{
  "record": {
    "contact_name": { "type": "SINGLE_LINE_TEXT", "value": "Joshua" },
    "address": { "type": "SINGLE_LINE_TEXT", "value": "1234 Yum street." },
    "notes": { "type": "MULTI_LINE_TEXT", "value": "" },
    "Last_user": {
      "type": "MODIFIER",
      "value": { "code": "Krispy", "name": "Krispy" }
    },
    "company_website": {
      "type": "LINK",
      "value": "https://www.shuaburgers.com/"
    },
    "telephone_number": { "type": "LINK", "value": "1234567890" },
    "$revision": { "type": "__REVISION__", "value": "1" },
    "Single_line_text_1": {
      "type": "SINGLE_LINE_TEXT",
      "value": "Delicious burgers!"
    },
    "Updated_datetime": {
      "type": "UPDATED_TIME",
      "value": "2019-04-08T08:24:00Z"
    },
    "Created_datetime": {
      "type": "CREATED_TIME",
      "value": "2019-04-08T08:24:00Z"
    },
    "company_name": {
      "type": "SINGLE_LINE_TEXT",
      "value": "Joshua's Burger Joint"
    },
    "Record_number": { "type": "RECORD_NUMBER", "value": "1" },
    "Author": {
      "type": "CREATOR",
      "value": { "code": "Krispy", "name": "Krispy" }
    },
    "department": { "type": "SINGLE_LINE_TEXT", "value": "Administration" },
    "job_title": { "type": "SINGLE_LINE_TEXT", "value": "CEO" },
    "representative": {
      "type": "USER_SELECT",
      "value": [{ "code": "Krispy", "name": "Krispy" }]
    },
    "email": { "type": "LINK", "value": "shua@shuaburgers.com" },
    "$id": { "type": "__ID__", "value": "1" }
  }
}

La primera propiedad de la respuesta es grabar. Las propiedades dentro de la propiedad grabar son los campos que existen en el registro sin ningún orden en particular. A modo de ejemplo, los pares clave-valor "company_name":{"type":"SINGLE_LINE_TEXT","value":"Joshua's Burger Joint"} muestra que el campo con el código de campo company_name es un Mensaje de texto con un valor de "Joshua's Burger Joint".

En cuatro sencillos pasos, se utilizó la API REST de Kintone para recuperar datos de registro de una aplicación Kintone mediante curl. Estos datos ahora se pueden utilizar para varias integraciones con otros servicios. Hay muchas otras API para las aplicaciones de Kintone, como las API para agregar nuevos registros o actualizar los registros existentes. Consulte la siguiente página para obtener más detalles sobre cómo usar la API REST de Kintone, incluidos otros tipos de autenticación, encabezados de solicitud y limitaciones:
Descripción general de la API REST de Kintone