APIキーの管理

sakura.ioの通信モジュールの登録、プロジェクト作成、連携サービスの設定、料金の確認といった操作はAPIを利用して行うこともできます。 APIを利用するためには、APIキーが必要です。

APIキーに関する操作を行うには sakura.ioコントロールパネル にログインします。

APIキーの発行

ログイン後、右上の会員IDが記載されたボタンをクリックし、 APIキー管理 をクリックするとAPIキー管理画面に遷移します。

../../../_images/api-open-create-dialog.png

APIキー管理画面の右上の APIキー追加 ボタンをクリックすると、APIキー追加のダイアログが開きます。

../../../_images/api-apikey-create.png

名前 および 権限 を指定し、 追加 ボタンをクリックすると一意の Token と Secret が生成されます。

../../../_images/api-accesslevel-create.png

注意事項

APIキーの Token および Secret は認証および各操作を実現するための重要な情報です。 また、会員毎にユニークなものが割り振られており、利用者の個人情報です。 SNSなどを通して第三者に共有したりせず、大切に保存してください。

APIキーの名称および権限の変更

名前や権限を変更したい場合は 編集 ボタンをクリックします。 該当画面で任意の項目を編集し、 保存 ボタンをクリックすることで設定内容を変更できます。

APIキーの削除

作成したAPIキーを削除したい場合は 削除 ボタンをクリックします。 削除する旨確認されますので、よろしければ 削除 ボタンをクリックします。

APIキーの権限について

APIキーには、 全権限 連携サービスの変更 読み取り権限 の３つの種類があります。

全権限

  • API経由のHTTPリクエストにおいて、 GET HEAD などの参照、及び POST PUT DELETE などの更新を許可します。

連携サービスの変更

  • API経由のHTTPリクエストにおいて、操作対象が連携サービスに限って、 GET HEAD などの参照、及び POST PUT DELETE などの更新を許可します。

読み取り権限

  • API経由のHTTPリクエストにおいて、 GET HEAD OPTIONS のみ許可します。