認証・認可
新しいアプリケーションを作成する
- ロジレスにサインアップします。
- アプリケーション一覧から「 新しいアプリケーションを登録 」 を行います。
- アプリケーションの登録が完了すると、クライアントIDとクライアントシークレットが取得できます。
ロジレスの認証ページを表示する
https://app2.logiless.com/oauth/v2/auth に、必要なパラメータを付加してGETリクエストを行ってください。 ロジレス ユーザIDの認証を行うページが表示されます。
パラメータ名 | 有効な値 |
---|---|
client_id | クライアントID |
response_type | "code" を指定 |
redirect_uri | アプリケーション登録時に入力したリダイレクトURLと同一のものを指定 |
URLにアクセスすると、認可ページが表示されます。 ロジレス ユーザIDを持つ利用者は、このページで、アプリケーションがアカウントのデータにアクセスすることを許可します。
認可コードを取得
利用者が認可ページにて承認ボタンを押下すると、ロジレスから認可コードが発行されます。 以下の方法で、アプリケーションから認可コードを取得し、アクセストークンと交換します。
Webサーバを用いる場合
redirect_uri に指定したURLへリダイレクトされます。 承認された場合、 code という名前のURLパラメータに認可コードが付与されます。 承認がキャンセルされた場合、またはエラーの場合、error パラメータにエラーの内容を表す英数字の文字列が付与されます。
認可コードの有効期限は30秒間です。
認可コードとアクセストークン、リフレッシュトークンを交換
認可コードを使って、アクセストークンとリフレッシュトークンを取得します。 https://app2.logiless.com/oauth2/token に、必要なパラメータを付加してGETリクエストを行ってください。
パラメータ名 | 有効な値 |
---|---|
client_id | クライアントID |
client_secret | クライアントシークレット |
code | 認可コード |
grant_type | "authorization_code" を指定 |
redirect_uri | アプリケーション登録時に入力したリダイレクトURLと同一のものを指定 |
レスポンス - リクエストが成功すると、以下のようなレスポンスがJSONで返ります。
{"access_token":"d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX","token_type":"bearer","expires_in":2592000,"refresh_token":d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX,"scope":""}
access_token プロパティに格納されている値が、アクセストークンです。 refresh_token プロパティに格納されている値が、リフレッシュトークンです。
アクセストークンを取得すれば、ロジレス API にアクセスする準備は完了です。
認可コードをアクセストークンに交換できるのは1度だけです。
APIの呼び出し
アクセストークン使用して HTTPリクエストを行うことで、ロジレスAPIにアクセスすることができます。 リクエスト、レスポンス、どちらも JSON でやりとりを行います。
Authorizationヘッダーでアクセストークンを送信して認証してください。
Authorization: Bearer {Access_Token}
各 API は、URL と HTTP メソッドで操作を表します。
- GET - 参照
- POST - 新規登録
- PUT - 更新
- DELETE - 削除
POST、PUTの際には、ヘッダにContent-Type: application/jsonをつけ、リクエストボディにJSONを送信します。 リクエストボディのJSONに日本語が含まれる場合は 文字コードはUTF-8、\uNNNN 形式でエンコードされている必要があります。
アクセストークンの再取得
アクセストークンの有効期間が過ぎると、そのトークンではアクセスできなくなります。その場合、アクセストークンと同時に送られてきたリフレッシュトークンを用いて、新たなトークンを取得する必要があります。
https://app2.logiless.com/oauth2/token に、必要なパラメータを付加してGETリクエストを行ってください。
パラメータ名 | 有効な値 |
---|---|
client_id | クライアントID |
client_secret | クライアントシークレット |
refresh_token | リフレッシュトークン |
grant_type | "refresh_token" を指定 |
レスポンス - リクエストが成功すると、以下のようなレスポンスがJSONで返ります。
{"access_token":"d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX","token_type":"bearer","expires_in":2592000,"refresh_token":d461ab8XXXXXXXXXXXXXXXXXXXXXXXXX,"scope":""}
access_token プロパティに格納されている値が、新しいアクセストークンです。