Package Exports
- @kintone/rest-api-client
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@kintone/rest-api-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
kintone-rest-api-client
- Installation
- Usage
- Parameters for
KintoneRestAPIClient
- Error Handling
- References
- Contribution Guide
- License
Installation
1. Install with npm
This library is distributed on npm
.
npm install @kintone/rest-api-client
You can then use require
or import
to import the library.
// CommonJS
const { KintoneRestAPIClient } = require("@kintone/rest-api-client");
// ES modules
import { KintoneRestAPIClient } from "@kintone/rest-api-client";
2. UMD files (for browser environment)
This library also provides two Universal Module Definition (UMD) files:
- https://unpkg.com/@kintone/rest-api-client@latest/umd/KintoneRestAPIClient.js
- minified one: https://unpkg.com/@kintone/rest-api-client@latest/umd/KintoneRestAPIClient.min.js
After loading this, you can use KintoneRestAPIClient
directly.
In Kintone customization, please add this URL in "JavaScript and CSS Customization" setting of your app.
NOTE: The UMD links are using the latest
tag to point to the latest version of the library. This pointer is unstable, it shifts as we release new versions. You should consider pointing to a specific version, such as 1.0.0
.
Usage
Here is a sample code that retrieves records of an app.
const client = new KintoneRestAPIClient({
baseUrl: "https://example.cybozu.com",
// Use password authentication
auth: {
username: process.env.KINTONE_USERNAME,
password: process.env.KINTONE_PASSWORD,
},
// Use API token authentication
// auth: { apiToken: process.env.KINTONE_API_TOKEN }
// Use session authentication if `auth` is omitted (in browser only)
});
client.record
.getRecords({ app: "1" })
.then((resp) => {
console.log(resp.records);
})
.catch((err) => {
console.log(err);
});
Parameters for KintoneRestAPIClient
Name | Type | Required | Description |
---|---|---|---|
baseUrl | String | Conditionally Required |
The base URL for your Kintone environment. It must start with https . (e.g. https://example.kintone.com) Required in Node.js environment. If you omit it in browser environment, location.origin will be used. |
auth | Object | Conditionally Required |
The object for authentication. See Authentication. |
guestSpaceId | Number or String | The guest space ID. If you are dealing with apps that are in guest spaces, please specify this. | |
basicAuth | Object | If your Kintone environment uses Basic authentication, please specify its username and password. | |
basicAuth.username | String | The username of Basic authentication. | |
basicAuth.password | String | The password of Basic authentication. |
Authentication
The client supports three authentication methods:
The required parameters inside auth
are different by the methods.
The client determines which method to use by passed parameters.
1. Parameters for Password authentication
Name | Type | Required | Description |
---|---|---|---|
username | String | Yes | |
password | String | Yes |
2. Parameters for API token authentication
Name | Type | Required | Description |
---|---|---|---|
apiToken | String or String[] | Yes | You can pass multiple api tokens as an array of string. |
3. Session authentication
Supported in browser environment only.
If you omit auth
parameter, the client uses Session authentication.
Error Handling
See Error Handling