Documentos de API

Solicitud de API REST de Kintone

Contenido

La solicitud de API de REST de Kintone permite ejecutar API de REST de Kintone desde código JavaScript.
Confiar únicamente en la API de JavaScript tiene limitaciones. Por ejemplo, la recuperación de datos de todos los registros dentro de una aplicación requiere el uso de la API REST de Kintone.
Aquí es donde usará la solicitud de API REST de Kintone para ejecutar la API REST.
No es necesario especificar encabezados de solicitud cuando se utiliza esta API.

Solicitud de API REST de Kintone - kintone.api()

REST con el atributo GET, POST, PUT, DELETE método.

Función

kintone.api(pathOrUrl, method, params, successCallback, failureCallback)

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
pathOrUrl Cuerda Sí La ruta de acceso de la API REST de Kintone, o la URL obtenida con kintone.api.url.
Si la URL de la API es https://{subdomain}.kintone.com/k/v1/xxx.jsony, a continuación, especifique el parámetro como /k/v1/xxx.json. Si la aplicación se va a utilizar dentro de un espacio de invitado, especifique el parámetro como kintone.api.url("/k/v1/xxx.json", true).
method Cuerda Sí El método HTTP. Especifique una de las siguientes opciones: GET / POST / PUT / DELETE.
params Objeto Sí Los parámetros que se van a utilizar con la API, especificados como un objeto.
successCallback Función Opcional La función de devolución de llamada a la que se llama cuando la API se realiza correctamente.
El parámetro de esta función es un objeto.
Si se ignora, se devolverá un objeto Promise que se puede completar con el parámetro pasado a la llamada de retorno.
failureCallback Función Opcional La función de devolución de llamada a la que se llama cuando se produce un error en la API.
El parámetro de esta función es una respuesta JSON. Si no se puede analizar la respuesta JSON, se proporcionará una cadena sin analizar.
Si se ignora la devolución de llamada, se devolverá un objeto Promise que se puede rechazar con el parámetro pasado a failureCallback.

Devuelve

Un Promise object se devolverá si el objeto successCallback o failureCallback se ignoran los parámetros. De lo contrario, no habrá respuesta.

Solicitud de muestra

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

function getRecords() {
  var body = {
    app: 1
  };

  // Kintone REST API Request calling the Kintone Get Record API
  kintone.api(kintone.api.url('/k/v1/records.json', true), 'GET', body, function(success) {
    // The function called on success
    var records = success.records;
    var recordSize = records.length + 1;
    window.alert('There are now currently ' + recordSize + ' records in this App.');
  }, function(error) {
    // The function called on error
    var errormsg = 'There was an error when retrieving the data.';
    window.alert(errormsg);
  });
}

kintone.events.on('app.record.create.submit', getRecords);

Solicitud de ejemplo mediante promesas

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

kintone.events.on('app.record.create.submit', function getRecords(event) {
  var body = {
    app: 1
  };

  kintone.api(kintone.api.url('/k/v1/records.json', true), 'GET', body).then(function(success) {
    var records = success.records;
    var recordSize = records.length + 1;
    window.alert('There are now currently ' + recordSize + ' records in this App.');
  }, function(error) {
    var errormsg = 'There was an error when retrieving the data.';
    window.alert(errormsg);
  });
});

Páginas disponibles

Limitaciones

No se pueden ejecutar las siguientes API de REST de Kintone.

Para ejecutar desde una personalización aplicada a la aplicación, use la API de búsqueda del navegador o XMLHttpRequest.

Notas

Cuando se envía una solicitud kintone.api() utilizando GET, y la longitud supera los 4 KB, se añadirá automáticamente el encabezado X-HTTP-Method-Override y la solicitud se enviará como una solicitud POST.
Para obtener más información, consulte el siguiente artículo:
X-HTTP-Method-Override