board APIを利用する

この機能を利用可能なユーザ権限
マスタアカウント 管理者 責任者 リーダー 担当者 カスタム権限
× × × 設定次第

 

APIを使って外部システムと連携することができます。

ここでは、board画面上でのAPIの設定の方法を記載します。APIの仕様やFAQ等は、board for developersをご覧ください。

APIの設定画面には、上メニューの「設定→API設定」から行くことができます。

 

なお、APIは、有料登録しているアカウントでのみ利用可能です。

 

APIキーとAPIトークン

board APIには、APIキーとAPIトークンがあります。

<APIキー>
アカウントで1つ発行され、リクエスト制限のためのリクエスト数は、このAPIキー単位にカウントされます。アカウントの識別キーのため、変更・削除はありません。

<APIトークン>
任意の数生成することができ、APIトークンごとに可能な操作(例:顧客の新規登録)を定義することができます。

セキュリティのため、可能な操作は最低限に範囲は限定することをお勧めします。そのため、用途に合わせてAPIトークンを登録し、必要な操作のみ有効にしてください。

 

APIを有効にする

初めてAPIを使用するときのみ、下図のような状態になっていますので、「APIを有効にする」を押してください。

 

APIを有効にするとAPIキーが生成されます。

 

APIトークンを生成する

 APIトークンの登録は、そのトークンを使って可能な操作にチェックを入れてください。下図の例ですと、
・顧客の登録
・顧客の取得
・顧客リストの取得
が可能なAPIトークンになります。それ以外のAPIにアクセスした場合は、403エラーが返ります。

また、「用途・説明」には、後からわかるような内容を入力してください。

 

APIトークン登録後、生成したトークンが表示されますが、APIトークンは登録直後の一度しか表示されませんので、忘れずに安全な場所に保管してください。

 

また、APIトークンの有効・無効を切り替えることができますので、一時的に利用できないようにする場合などにご利用ください。

 

APIキー・APIトークンを使用する

生成したAPIキー・APIトークンは、リクエストヘッダに指定してください。

詳しくは、APIドキュメントの「認証・認可」をご覧ください。



APIで請求書等の書類を作成する ››
一覧に戻る