APIキー

Web API を利用するには、アプリケーションごとに API キーが必要です。サービスを呼び出す各アプリケーションに対して、少なくとも 1 つのキーを作成してください。

API キーは、呼び出し元が属するユーザーアカウントの権限を付与しますが、アプリケーションに必要な権限のみを許可するために、権限のセットは制限されています。これにより、どのアプリケーションがデバイスにアクセスできるかを管理することができ、外部サービスとアカウントの認証情報を共有する必要がなくなります。

APIキーの作成

APIキーはダッシュボードの「APIキー」ページから作成できます。新しいAPIキーを作成するには、次の手順に従ってください。

1[+ 新規] ボタンをクリックして「新規APIキーの追加」ダイアログを開きます。

2任意の名称（キーの対象となるアプリケーションや顧客など）を入力し、必要に応じて説明を入力します。

3キーに付与するアクセス許可を有効にします。
たとえば、印刷ジョブを送信できるようにする場合は、"PrintToDevice" を有効にします。ユーザータイプで使用可能な任意のアクセス許可を有効にできます。

4[追加] ボタンをクリックして、キーを作成します。

アプリケーションは、付与した制限された権限のセットで、このキーを使用してデバイスグループやデバイスにアクセスできるようになります。

APIキーを使用したWeb APIの呼び出し

APIキーは、GUID 形式の16進数文字列です。この文字列は、ダッシュボードの「API キー」ページから表示/コピーできます。

Web API を呼び出すには、クエリオプションkeyまたはリクエストヘッダーStar-Api-Keyを使用してキーデータを渡す必要があります。

実行例：
curlコマンドを使用してデバイスグループのリストを取得します。（実行例のPOST先は日本環境）

リクエストヘッダー


curl --header "Star-Api-Key: 6800ffd6-2367-4c8d-b067-d6a28151276a" https://jp-api.stario.online/v1/a

APIキーの変更

ダッシュボードの「API キー」ページから、そのAPIキーの [編集] ボタンをクリックすることで、名称、説明、権限をいつでも変更できます。

APIキーの削除

ダッシュボードの「API キー」ページから、そのAPIキーの [削除] ボタンをクリックすることでいつでも削除できます。

この操作により、そのキーを使用して認証するアプリケーションのデバイスおよびデバイスグループへのアクセスがすぐに無効になります。

注意：
APIキーの削除は永久的なものであり、同じ文字列で新しいキーを作成することはできません。
削除されたキーを使用しているアプリケーションは、新しいキーが付与されるまでサービスにアクセスすることが完全にできなくなります。

APIキーの無効化

すべてのアクセス許可を無効にすることで、APIキーを削除することなくAPIへのアクセスを一時的に無効にすることができます。