APIを利用する
この記事について
APIの利用方法についてご案内します。Perlunaでは、すべての操作がAPIとして公開されています。APIを利用することで、別システムと連携したり、Perlunaのデータにアクセスすることが可能です。
APIの概要
- REST形式で提供しております
- 後述するAPIキーを生成し X-API-Key ヘッダーにAPIキーを設定してリクエストをすることで、APIへのアクセスが可能です
- APIにアクセスするユーザーの権限は、APIキーを発行したユーザーの権限となります
- 利用可能なAPIのエンドポイント一覧は↓をご確認ください
APIキーの作成及びAPIへのアクセスは管理者のみ可能です
APIエンドポイント一覧
API エンドポイント一覧 を参照してください
操作手順 APIキーの発行
APIキーが不要になった場合、削除をしてください
APIキーが他人に漏れるなどした場合、削除をして再度作成をしてください
基本情報
APIキー名*
任意のAPIキーを入力します
APIを試す
取得したAPIキーを使い API エンドポイント一覧 にあるAPIを試すことができます。最も簡単なAPIは、現在のユーザー情報を取得するAPIです
curlを使った例(Windows)
curl "https://api.perluna.jp/api/auth/current-user" -H "X-API-Key: xxxx"レスポンス例
{"id":"XXXX","name":"XXXX" ... }
解決しましたか？
😞
😐
🤩