Documentos de API

Agregar invitados

Agrega usuarios invitados a Kintone.
Esto no afilia a los usuarios invitados con ningún espacio de invitado y no envía ningún correo electrónico de invitación.
Para afiliar a un usuario invitado con un espacio de invitado, realice un seguimiento de esta llamada a la API con la API Update Guest Members. Para obtener más información, consulte el siguiente documento:
Actualizar a los miembros invitados

MétodoPOST
URLhttps://{subdomain}.kintone.com/k/v1/guests.json
Autenticación Autenticación de contraseña , Autenticación de sesión
Content-Typeapplication/json

Contenido

Permisos

  • Solo los administradores de Kintone pueden usar esta API.

Parámetros de solicitud

Parámetro Tipo Obligatorio Descripción
guests Arreglo Sí Una lista de datos de usuarios invitados.
guests[].name Cuerda Sí El nombre para mostrar del usuario.
Debe tener entre 1 y 128 caracteres.
guests[].code Cuerda Sí La dirección de correo electrónico (nombre de inicio de sesión) del usuario invitado.
guests[].password Cuerda Sí La contraseña de inicio de sesión del usuario invitado.
guests[].timezone Cuerda Sí La zona horaria del usuario invitado.
guests[].locale Cuerda La configuración de idioma del usuario invitado.
  • auto: Utilice la configuración del navegador web.
  • en: Inglés
  • zh: Chino
  • ja: Japonés
Si se ignora, auto se establecerá.
guests[].image Cuerda La imagen de perfil del usuario invitado.
Especifique una fileKey de un archivo cargado. fileKeys se puede encontrar a partir de la respuesta de la API de carga de archivos. Para obtener más información, consulte el siguiente artículo:
Subir archivo
Si se ignora, se establecerá una imagen predeterminada.
guests[].surNameReading Cuerda La configuración del apellido fonético del usuario invitado. El límite máximo es de 64 caracteres.
guests[].givenNameReading Cuerda La configuración del nombre de pila fonético del usuario invitado. El límite máximo es de 64 caracteres.
guests[].company Cuerda El nombre de la empresa que se mostrará en el perfil del usuario invitado.
El límite máximo es de 100 caracteres.
guests[].division Cuerda El nombre del departamento que se mostrará en el perfil del usuario invitado.
El límite máximo es de 100 caracteres.
guests[].phone Cuerda El número de teléfono que se mostrará en el perfil del usuario invitado.
El límite máximo es de 100 caracteres.
guests[].callto Cuerda El nombre de Skype del usuario invitado.
El límite máximo es de 256 caracteres.

Solicitud de muestra

JavaScript using kintone.api() 

 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

var body = {
  'guests': [
    {
      'code': 'guest1@example.com',
      'password': 'password',
      'timezone': 'America/Los_Angeles',
      'locale': 'en',
      'image': '78a586f2-e73e-4a70-bec2-43976a60746e',
      'name': 'John Doe',
      'company': 'Company Name',
      'division': 'Sales',
      'phone': '999-456-7890',
      'callto': 'skypecallto'
    },
    {
      'code': 'guest2@example.com',
      'password': 'password',
      'timezone': 'America/Los_Angeles',
      'locale': 'en',
      'image': '78a586f2-e73e-4a70-bec2-43976a60746e',
      'name': 'Jane Roe',
      'company': 'Company Name',
      'division': 'Sales',
      'phone': '999-456-7890',
      'callto': 'skypecallto'
    }
  ]
};

kintone.api(kintone.api.url('/k/v1/guests.json', true), 'POST', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 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

var body = {
  'guests': [
    {
      'code': 'guest1@example.com',
      'password': 'password',
      'timezone': 'America/Los_Angeles',
      'locale': 'en',
      'image': '78a586f2-e73e-4a70-bec2-43976a60746e',
      'name': 'John Doe',
      'company': 'Company Name',
      'division': 'Sales',
      'phone': '999-456-7890',
      'callto': 'skypecallto'
    },
    {
      'code': 'guest2@example.com',
      'password': 'password',
      'timezone': 'America/Los_Angeles',
      'locale': 'en',
      'image': '78a586f2-e73e-4a70-bec2-43976a60746e',
      'name': 'Jane Roe',
      'company': 'Company Name',
      'division': 'Sales',
      'phone': '999-456-7890',
      'callto': 'skypecallto'
    }
  ],
  // CSRF TOKEN: used for all APIs that have an HTTP method of POST, PUT and DELETE on Kintone.
  '__REQUEST_TOKEN__': kintone.getRequestToken()
};

var url = 'https://{subdomain}.kintone.com/k/v1/guests.json';
var xhr = new XMLHttpRequest();
xhr.open('POST', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send(JSON.stringify(body));

Parámetros de respuesta

Se devolverá un objeto JSON vacío.

Ejemplo de respuesta

1

{}

Limitaciones

  • Los usuarios invitados se agregarán al dominio de Kintone, pero no se enviarán correos electrónicos de invitación a los usuarios invitados.
  • La configuración de activación/desactivación de las funciones Space o Guest Space no afecta a esta API.
  • La configuración de notificaciones por correo electrónico del usuario invitado estará activada de forma predeterminada.