Download OpenAPI specification:Download
クラウドBOT RESTful APIのリファレンスです。
APIを利用するには、公開IDの設定とアクセストークンの発行が必要です。
クラウドBOTダッシュボード > 開発者向けページから設定してください。
https://console.c-bot.pro/development
リクエストペイロードおよびレスポンスにマルチバイト文字が含まれる場合はUTF-8として扱います。
リクエストペイロード容量が4MBを超えるリクエストは拒否されます。
API機能が有効な契約の一覧を参照します。
使用するアクセストークンに「参照」権限が付与されている必要があります。
properties | string Example: properties=plan,owner 追加で取得するプロパティ名集合 |
content-type required | string Value: "application/json" |
content-language required | string Enum: "ja" "en" |
access-token | string アクセストークン |
secret-key | string シークレットキー |
authorization | string Value: "Bearer {トークン}" OAuthアクセストークン |
[OK] 契約一覧がレスポンスされました。
[Unauthorized] アクセストークン・シークレットキーが正しくありません。
[Forbidden] アクセストークンに参照権限がありません。
[Payload Too Large] ペイロードが大きすぎます。
[Unsupported Media Type] content-typeが正しくありません。
[Unprocessable Entity] リクエスト内容が不正です。
{- "code": 200,
- "contracts": [
- {
- "public_id": "example1",
- "public_path": "/example1/",
- "plan": "フリー",
- "owner": "example1@example.com",
- "timezone": "Asia/Tokyo",
- "location": "日本",
- "name": null,
- "organization": null,
- "postcode": null,
- "address": null,
- "phone": null,
- "department": null,
- "username": null
}, - {
- "public_id": "example2",
- "public_path": "/example2/",
- "plan": "シングルオフィス",
- "owner": "example2@example.com",
- "timezone": "Asia/Tokyo",
- "location": "日本",
- "name": "本社",
- "organization": "株式会社クラウドBOT",
- "postcode": "000-0000",
- "address": "東京都墨田区押上1丁目1−2",
- "phone": "000-0000-0000",
- "department": "総務部",
- "username": "山田 太郎"
}
]
}
API公開されているBOTの一覧を参照します。
使用するアクセストークンに「参照」権限が付与されている必要があります。
public_id required | string APIの公開ID |
properties | string Example: properties=icon,created,last_modified,creator 追加で取得するプロパティ名集合 |
content-type required | string Value: "application/json" |
content-language required | string Enum: "ja" "en" |
access-token | string アクセストークン |
secret-key | string シークレットキー |
authorization | string Value: "Bearer {トークン}" OAuthアクセストークン |
[OK] BOT一覧がレスポンスされました。
[Unauthorized] アクセストークン・シークレットキーが正しくありません。
[Forbidden] アクセストークンに参照権限がありません。
[Payload Too Large] ペイロードが大きすぎます。
[Unsupported Media Type] content-typeが正しくありません。
[Unprocessable Entity] リクエスト内容が不正です。
{- "code": 200,
- "bots": [
- {
- "id": "get_items",
- "name": "商品取得BOT",
- "description": "商品リストを取得するBOTです。",
- "icon": "data:image/png;base64,0000000000",
- "created": "2020-04-06T14:32:23Z",
- "last_modified": "2020-04-07T15:10:02Z",
- "creator": "example@example.com"
}, - {
- "id": "add_item",
- "name": "商品追加BOT",
- "description": "商品を登録するBOTです。",
- "icon": "data:image/png;base64,0000000000",
- "created": "2020-04-07T06:29:41Z",
- "last_modified": "2020-04-07T09:41:44Z",
- "creator": "example@example.com"
}
]
}
BOTの詳細を参照します。
使用するアクセストークンに「参照」権限が付与されている必要があります。
public_id required | string APIの公開ID |
bot_id required | string BOT ID |
properties | string Example: properties=icon,created,last_modified,creator,input,output 追加で取得するプロパティ名集合 |
content-type required | string Value: "application/json" |
content-language required | string Enum: "ja" "en" |
access-token | string アクセストークン |
secret-key | string シークレットキー |
authorization | string Value: "Bearer {トークン}" OAuthアクセストークン |
[OK] BOT詳細がレスポンスされました。
[Unauthorized] アクセストークン・シークレットキーが正しくありません。
[Forbidden] アクセストークンに参照権限がありません。
[Not Found] BOTが存在しません。
[Payload Too Large] ペイロードが大きすぎます。
[Unsupported Media Type] content-typeが正しくありません。
[Unprocessable Entity] リクエスト内容が不正です。
{- "code": 200,
- "id": "add_item",
- "name": "商品追加BOT",
- "description": "商品を登録するBOTです。",
- "icon": "data:image/png;base64,0000000000",
- "created": "2020-04-07T06:29:41Z",
- "last_modified": "2020-04-07T09:41:44Z",
- "creator": "example@example.com",
- "input": {
- "data": {
- "ログインID": {
- "type": "string"
}, - "パスワード": {
- "type": "string"
}, - "商品": {
- "type": "group",
- "data": {
- "商品名": {
- "type": "string"
}, - "価格": {
- "type": "string"
}, - "画像": {
- "type": "files"
}, - "タグ": {
- "type": "string[]"
}
}
}
}
}, - "output": {
- "data": {
- "商品": {
- "type": "group",
- "data": {
- "商品ID": {
- "type": "string"
}
}
}
}
}
}
BOTを削除します。
使用するアクセストークンに「編集」権限が付与されている必要があります。
public_id required | string APIの公開ID |
bot_id required | string BOT ID |
content-type required | string Value: "application/json" |
content-language required | string Enum: "ja" "en" |
access-token | string アクセストークン |
secret-key | string シークレットキー |
authorization | string Value: "Bearer {トークン}" OAuthアクセストークン |
[OK] BOTが削除されました。
[Unauthorized] アクセストークン・シークレットキーが正しくありません。
[Forbidden] アクセストークンに編集権限がありません。
[Not Found] BOTが存在しません。
[Payload Too Large] ペイロードが大きすぎます。
[Unsupported Media Type] content-typeが正しくありません。
[Unprocessable Entity] リクエスト内容が不正です。
{- "code": 200
}
任意のBOTを実行します。
使用するアクセストークンに「実行」権限が付与されている必要があります。
public_id required | string APIの公開ID |
bot_id required | string BOT ID |
content-type required | string Value: "application/json" |
content-language required | string Enum: "ja" "en" |
access-token | string アクセストークン |
secret-key | string シークレットキー |
authorization | string Value: "Bearer {トークン}" OAuthアクセストークン |
timeout | integer [ 0 .. 25000 ] BOT実行の終了を待機するミリ秒数(未指定の場合は0) |
callback_endpoint | string <uri> BOT実行完了時に、このエンドポイント宛に実行結果がPOSTされます。(未指定の場合はコールバック無し) |
callback_tries | integer [ 0 .. 5 ] コールバックPOSTの試行回数です。callback_endpointが200系以外のステータスコードをレスポンスした場合またはレスポンスヘッダに正しいアクセストークンが設定されていなかった場合に、指定回数まで試行します。0を指定した場合はコールバックPOSTは行われません。 |
input | object (datalist_input) 入力値を表すオブジェクトです。(未指定の場合はBOTのデフォルト値が使用されます) |
[Created] BOT実行が完了しました。
[Accepted] BOT実行は継続中です。
[Unauthorized] アクセストークン・シークレットキーが正しくありません。
[Forbidden] アクセストークンに実行権限がありません。
[Not Found] BOTが存在しません。
[Gone] BOT実行は中断されました。
[Payload Too Large] ペイロードが大きすぎます。
[Unsupported Media Type] content-typeが正しくありません。
[Unprocessable Entity] リクエスト内容が不正です。
[Locked] BOTの実行がロックされています。稼働時間または使用容量が超過しています。
[Too Many Requests] BOTの同時実行数の制限を超えたリクエストです。
{- "timeout": 20000,
- "input": {
- "検索ワード": "クラウドBOT"
}
}
{- "code": 201,
- "job_id": "00000000-0000-0000-0000-000000000000",
- "bot_id": "get_items",
- "bot_name": "商品取得BOT",
- "status": 0,
- "start_time": "2019-12-02T05:30:13Z",
- "elapsed_time": 6,
- "output": {
- "件数": "2",
- "商品": [
- {
- "商品名": "チーズケーキ",
- "価格": "500",
- "画像": {
- "type": "files",
- "files": [
- {
- "ref": "jobs/00000000-0000-0000-0000-000000000000/files/00000000-0000-0000-0000-000000000000",
- "meta": {
- "name": "0001.jpg",
- "size": 603956,
- "timestamp": 1513657350000
}
}
]
}, - "タグ": [
- "ケーキ",
- "チーズ"
]
}, - {
- "商品名": "ガトーショコラ",
- "価格": "600",
- "画像": {
- "type": "files",
- "files": [
- {
- "ref": "jobs/00000000-0000-0000-0000-000000000000/files/00000000-0000-0000-0000-000000000001",
- "meta": {
- "name": "0002.jpg",
- "size": 694475,
- "timestamp": 1651024763990
}
}
]
}, - "タグ": [
- "ケーキ",
- "チョコレート"
]
}
]
}
}
BOTのジョブ一覧を参照します。
使用するアクセストークンに「実行」または「参照」権限が付与されている必要があります。
レスポンスサイズが4MBを超える場合は400エラーをレスポンスします。
public_id required | string APIの公開ID |
bot_id required | string BOT ID |
properties | string Example: properties=output 追加で取得するプロパティ名集合 |
limit | integer >= 0 Example: limit=10 アイテムの取得件数上限 |