ロジクラ API (1.0)

ロジクラ API は OAuth 2.0 の認可コードフローを使用します。

アプリケーションの登録

API を利用するには、https://logikura.com/oauth/applications にアクセスしてアプリケーションを登録し、クライアント ID とクライアントシークレットを取得してください。

登録時に、アプリケーションが必要とするスコープを選択してください。

認可コードフロー

1. 認可コードの取得

以下の URL にリダイレクトすると、ロジクラのアクセス許可画面が表示されます。ユーザーが承認すると、認可コードが発行されます。

https://logikura.com/oauth/authorize?response_type=code&client_id={CLIENT_ID}&redirect_uri={REDIRECT_URI}&scope={SCOPE}

ユーザーが承認すると、指定したリダイレクト URI に認可コードが付与されてリダイレクトされます。認可コードの有効期限は 10 分 です。

{REDIRECT_URI}?code={AUTHORIZATION_CODE}

2. アクセストークンの取得

取得した認可コードを使ってアクセストークンとリフレッシュトークンを発行します。

curl --request POST 'https://logikura.com/oauth/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'grant_type=authorization_code&code={AUTHORIZATION_CODE}&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}&redirect_uri={REDIRECT_URI}'

レスポンス例:

{
  "access_token": "...",
  "token_type": "Bearer",
  "expires_in": 86400,
  "refresh_token": "...",
  "scope": "read write",
  "created_at": 1234567890
}

3. API リクエスト

取得したアクセストークンを Authorization ヘッダーに指定してリクエストを送信します。

Authorization: Bearer {ACCESS_TOKEN}

例:

curl --request GET 'https://api.logikura.com/api/v1/warehouses' \
  --header 'Authorization: Bearer {ACCESS_TOKEN}'

トークンの更新

アクセストークンの有効期限が切れた場合、リフレッシュトークンを使って新しいアクセストークンを取得できます。

curl --request POST 'https://logikura.com/oauth/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'grant_type=refresh_token&refresh_token={REFRESH_TOKEN}&client_id={CLIENT_ID}&client_secret={CLIENT_SECRET}'

リフレッシュトークンには 90 日間の有効期限 があります。有効期限が切れた場合は、1. 認可コードの取得 から再度実行してアクセストークンを再発行してください。

ロジクラAPIでは1分あたり100回のリクエスト制限を設けています。 リクエスト制限に関する情報はヘッダに含まれています。

リストを返すAPIに関しては応答にLinkヘッダーを追加します。

<https://api.logikura.com/api/v1/path/to?page=1>; rel="prev",
<https://api.logikura.com/api/v1/path/to?page=3>; rel="next"