🤖
Postmanでkintone REST APIにリクエストを送る
kintoneではAPIを用いてレコードを追加したり、編集したりできます。
APIリクエストを試すにはPostmanを使うと、GUIで項目を設定できたり、レスポンスも見やすいので便利です。
この記事では、レコード登録APIをサンプルとしてPostmanからリクエストを送る方法をまとめます。
レコード登録API
公式ドキュメントは以下のとおりです。
Postmanでの操作
URLの指定
レコード登録APIのURLとHTTPメソッドを指定します。
| 項目 | 値 |
|---|---|
| HTTPメソッド | POST |
| URL | https://【サブドメイン】.cybozu.com/k/v1/record.json |
認証情報の設定
レコード登録APIを利用するには認証が必要です。
認証方法はいくつかの方法がありますが、ここではAPIキーを用います。
認可タブで、認可タイプ「APIキー」を選択して必要項目を入力します。
| 項目 | 値 |
|---|---|
| 認可タイプ | APIキー |
| キー | X-Cybozu-API-Token |
| 値 | 【APIキー】 |
| 追加先 | ヘッダー |
登録内容
レコードの登録内容はBodyに指定します。
Postmanではボディタブで、Rawを選択しJSONで入力します。
{
"app": 【アプリID】,
"record": {
"文字列__1行_": {
"value": "test"
}
}
}
リクエスト送信
Postmanの「送信」ボタンを押下すると、リクエストが送信されます。
レスポンスのボディに200 OKと表示されれば成功です。
まとめ
PostmanではGUIでAPIへリクエストを送信できます。
認証情報を設定したり、ボディに設定するのも簡単です。
Discussion