@kintone/rest-api-client-wechat-mp/README.md

kintone REST API client for WeChat Mini Program

# kintone-rest-api-client-wechat-mp

[![npm version](https://badge.fury.io/js/%40kintone%2Frest-api-client-wechat-mp.svg)](https://badge.fury.io/js/%40kintone%2Frest-api-client-wechat-mp)

An API client for Kintone REST API, it is used in WeChat Mini Program client.<br>
It is based on [@kintone/rest-api-client@v1.2.0](https://github.com/kintone/js-sdk/tree/%40kintone/rest-api-client%401.2.0/packages/rest-api-client). <br>
It wraps the functions of app, record and bulkRequest of "@kintone/rest-api-client", and develops the new functions of file.

## Requirement

- [WeChat Developer Tool](https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html) (The latest)<br>
Base library version of the Mini Program: 2.2.2 or later

## Usage

**Step 1**

Open WeChat Developer Tool and create a new project. (Ref. [小程序开发指南](https://developers.weixin.qq.com/ebook?action=get_post_info&docid=0008aeea9a8978ab0086a685851c0a))

**Step 2**

Install with `npm`

```shell
cd [your-project-directory]
npm init -y
npm install @kintone/rest-api-client-wechat-mp
```

**Step 3**

Modify the setting of "WeChat Developer Tool"<br>
Check the setting "增强编译" and "使用npm模块". (Ref. [代码编译 - 增强编译](https://developers.weixin.qq.com/miniprogram/dev/devtools/codecompile.html#%E5%A2%9E%E5%BC%BA%E7%BC%96%E8%AF%91))<br>
![](/docs/images/setting.png)

Build npm<br>
Click "工具" > "构建npm" (Ref. [npm 支持](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html))<br>
![](/docs/images/build.png)<br>

### Sample code

```js
const {KintoneRestAPIClientWeChatMP} = require('@kintone/rest-api-client-wechat-mp');
const client = new KintoneRestAPIClientWeChatMP({
  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 }
});

client.record
  .getRecords({ app: "1" })
  .then((resp) => {
    console.log(resp.records);
  })
  .catch((err) => {
    console.log(err);
  });
```

## Parameters for `KintoneRestAPIClientWeChatMP`

| Name                       |                               Type                               |          Required           | Description                                                                                                                                                                                                                  |
| -------------------------- | :--------------------------------------------------------------: | :-------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| baseUrl                    |                              String                              |          Required           | The base URL for your Kintone environment.<br />It must start with `https`. (e.g. https://example.kintone.com)                                                                                                               |
| auth                       |                              Object                              |          Required           | The object for authentication. See [Authentication](#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:

1. [Password authentication](https://developer.kintone.io/hc/en-us/articles/212495188#passwordAuth)
2. [API token authentication](https://developer.kintone.io/hc/en-us/articles/212495188#APItokenAuth)

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](https://developer.kintone.io/hc/en-us/articles/212495188#passwordAuth)

| Name     |  Type  | Required |    Description    |
| -------- | :----: | :------: | ----------------- |
| username | String |   Yes    | User's login name |
| password | String |   Yes    | User's password   |

#### 2. Parameters for [API token authentication](https://developer.kintone.io/hc/en-us/articles/212495188#APItokenAuth)

| Name     |        Type        | Required | Description                                             |
| -------- | :----------------: | :------: | ------------------------------------------------------- |
| apiToken | String or String[] |   Yes    | You can pass multiple api tokens as an array of string. |

## References

- [File](docs/file.md)

The usage of following functions is not changed, you can refer to the doc of "@kintone/rest-api-client".<br>
Pay attention to the class name, you should use KintoneRestAPIClientWeChatMP in WeChat. Refer to [Sample code](#sample-code).
- [@kintone/rest-api-client/errorHandling](https://github.com/kintone/js-sdk/blob/%40kintone/rest-api-client%401.2.0/packages/rest-api-client/docs/errorHandling.md)
- [@kintone/rest-api-client/record](https://github.com/kintone/js-sdk/blob/%40kintone/rest-api-client%401.2.0/packages/rest-api-client/docs/record.md)
- [@kintone/rest-api-client/app](https://github.com/kintone/js-sdk/blob/%40kintone/rest-api-client%401.2.0/packages/rest-api-client/docs/app.md)
- [@kintone/rest-api-client/bulkRequest](https://github.com/kintone/js-sdk/blob/%40kintone/rest-api-client%401.2.0/packages/rest-api-client/docs/bulkRequest.md)

## License

- [MIT](LICENSE.md)

## Copyright

Copyright(c) Cybozu, Inc.