APIの利用

1️⃣この記事について

Perlunaの操作は、REST形式のAPIとして公開されています。APIを使うと、他のシステムとデータを連携したり、Perlunaのデータを取得・更新したりできます。使いどころは外部システムと連携するも参照してください。

2️⃣前提

APIを使うための前提です。

• APIキーが必要です。APIキーの発行は管理者の権限が必要です。→ APIキーの発行、メンバーの権限

3️⃣APIの概要

• 認証は、APIキーを X-API-Key ヘッダーに設定して行います。APIキーの発行はAPIキーの発行を参照してください。
• APIを使うときの権限は、APIキーを発行したユーザーの権限になります。
• 利用できるAPIの一覧は、APIドキュメントを参照してください。

4️⃣操作手順

APIを試す

発行したAPIキーで、APIドキュメントにあるAPIを試せます。もっとも簡単なのは、現在のユーザー情報を取得するAPIです。xxxx の部分を、発行したAPIキーに置き換えて実行します。

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

ユーザーの情報がJSONで返れば、APIキーが使えています。

5️⃣注意点

カスタムフィールドの値もAPIで取得できます

カスタムフィールドの値も、コードをキーとしてAPIで取得できます。→ カスタムフィールドの登録