AppID と AppKey

AppID と AppKey は、REST API を実行したアプリケーションの特定に利用されます。

これらの値は以下の2箇所で使われます。

アクセス先 URL

多くの REST API において、アクセス先 URL は AppID を含んだ形式をとります。

一例として、ユーザー作成の際に使用するアクセス先 URL は以下のようになります。

https://api-jp.kii.com/api/apps/{APP_ID}/users

上記アクセス先 URL の {APP_ID} を、アプリケーションの AppID に差し替えてください。

HTTP ヘッダ

Kii Cloud は、以下の HTTP ヘッダを元にアプリケーションを特定します。

なお X-Kii-AppID/X-Kii-AppKey ヘッダによるアプリケーション特定は後方互換のための機能です。原則 Authorization ヘッダ方式を利用してください。

Authorization ヘッダ

アクセストークン(Authorization: Bearer)

こちらの説明 にもあるように、多くの API はアクセストークンを Authorization: Bearer の形で埋め込みリクエストを送信します。

Kii Cloud は埋め込まれたアクセストークンを元にアプリケーションを特定します。

Basic 認証(Authorization: Basic)

ログイン処理など、アクセストークンを必要としない API がいくつか存在します。

これらの API については Basic 認証を使ってリクエストを送信します。具体的には AppID をユーザー名、AppID をパスワードとして指定の上 Authorization: Basic に認証情報を埋め込み、リクエストを送信します(詳しくは こちら をご参照ください)。

Kii Cloud は埋め込まれた認証情報を元にアプリケーションを特定します。

X-Kii-AppID/X-Kii-AppKey ヘッダ

アクセストークンを必要としない API については、Basic 認証を使わずに直接 AppID と AppKey を X-Kii-AppIDX-Kii-AppKey ヘッダに埋め込んでリクエスト送信することも可能です。

Kii Cloud は埋め込まれた AppID/AppKey を元にアプリケーションを特定します。

AppID と AppKey をクライアントアプリに埋め込んでも、アクセス制御を正しく行えば安全性は確保できます。詳細は、セキュリティをご覧ください。