コンテンツにスキップ

API

JamCloud APIを使うと、スクリプトや表計算、ほかのアプリからワークスペースを読み取り、変更できます。トラックの一覧、ファイルのインポート、セクションやコード譜の取得などです。APIに見えるのは、あなたがメンバーになっている各ワークスペースで、あなたに見えるものと同じです。

個人用キー(jc_ で始まります)は、APIに対してあなたを表します。すべてのアカウントにキーが含まれるわけではありません。管理者がアクセスを付与できます。付与されていない場合、設定 › APIキー にアカウントにAPIアクセスが含まれていないと表示されます。

設定 › APIキー でキーに名前を付け、次を選びます。

  • 読み取り専用:読み取るだけで、何も変更しません。
  • 読み取りと書き込み:インポート、編集、削除もできます。各ワークスペースでのあなたの役割の範囲内です。
  • 有効期限:無期限、または30日、90日、365日。

キーが表示されるのは キーを作成 の直後の一度だけです。コピーして、パスワードと同じように安全に保管してください。その後の一覧には、先頭部分、最終使用日、有効期限だけが表示されます。取り消す でキーはすぐに無効になります。有効なキーは10個まで持てます。

キーを Authorization ヘッダーで送ります。

curl -H "Authorization: Bearer jc_…" https://api-jamcloud.australfactory.cl/api/v1/groups

これでワークスペースの一覧が返ります。ほかのほとんどのルートはワークスペースの下にあります(/api/v1/groups/<id>/…)。

キーはアカウントには決して届きません。サインイン、プロフィール、セキュリティ、通知、ほかのAPIキー、管理(/auth、/me、/admin、/realtime、/api-keys)は、コード api_key_forbidden で 403 を返します。これらはアプリで管理してください。読み取り専用 のキーで何かを変更しようとすると、403 api_key_read_only が返ります。

APIが一時的に停止しているときは、キーを使ったすべての呼び出しに 503 circuit_open が返ります。Retry-After ヘッダーの秒数だけ待ってから、もう一度お試しください。アプリ自体はそのまま使えます。

APIリファレンス(バージョン1)には、キーで呼び出せるすべてのルートが、パラメーター、フィールド、すぐに実行できる例とともに載っています。