APIを利用する

1️⃣この記事について

APIの利用方法についてご案内します。ハヤサブでは、すべての操作がAPIとして公開されています。APIを利用することで、別システムと連携したり、簡単にハヤサブのデータにアクセスすることが可能です。

2️⃣APIの概要

• REST形式で提供しております
• 後述するAPIキーを生成し X-API-Key ヘッダーにAPIキーを設定してリクエストをすることで、APIへのアクセスが可能です
• APIにアクセスするユーザーの権限は、APIキーを発行したユーザーの権限となります
• 利用可能なAPIのエンドポイント一覧は↓をご確認ください

注意

現在β版として提供中の機能のため、仕様が変わることがございます。ご了承ください

注意

APIキーの作成及びAPIへのアクセスは管理者のみ可能です

3️⃣APIエンドポイント一覧

API エンドポイント一覧 を参照してください

4️⃣操作手順 APIキーの発行

1. 「設定」→「APIキー」を開く

   サイドバーの「設定」を開き、上部のタブから「APIキー」を選択します。発行済みのAPIキー一覧が表示されます。右上の「APIキーを追加」をクリックします。

   

   注意

   APIキーの作成は管理者のみ可能です。

2. 「APIキーを作成」ダイアログを開く

   「APIキー名」（必須）の入力欄があるダイアログが表示されます。

   

3. APIキー名を入力して「保存」をクリックする

   用途がわかる名前（例: 連携用APIキー）を入力し、「保存」をクリックします。

   

4. 発行されたことを確認する

   保存に成功すると「作成しました」と表示され、一覧に発行したAPIキーが追加されます。発行されたキー値は一覧の「APIキー」列で確認でき、右側のコピーアイコンからコピーできます。

   

   ヒント

   APIにアクセスするユーザーの権限は、APIキーを発行したユーザーの権限となります。

注意

APIキーが不要になった場合は、行の操作メニュー（⋮）から『削除』で削除をしてください。

注意

APIキーが他人に漏れるなどした場合は『削除』をして再度作成をしてください。

5️⃣APIを試す

取得したAPIキーを使い API エンドポイント一覧 にあるAPIを試すことができます。最も簡単なAPIは、現在のユーザー情報を取得するAPIです

curlを使った例(Windows)

curl "https://api.hayasub.com/api/auth/current-user" -H "X-API-Key: xxxx"

レスポンス例

{"id":"XXXX","name":"XXXX" ... }