コンテンツにスキップ
ShopentlyLearn
日本語

認証

APIキーを作成する

アプリケーションをストアに接続するには、APIキーが必要です。管理画面で権限を選び、アプリケーションが読み取れるデータと変更できる内容を指定してください。

アプリケーションがAPIに接続する際のIPアドレスも指定できます。指定した場合、そのアドレスからのみキーを使用できます。設定後にAPIキーを作成してください。

アクセストークンを取得

アクセストークンを使うと、リクエストごとにAPIキーを送信せずにリクエストを送れます。不要になったトークンは取り消すことができます。

トークンと一緒に、ストアで利用できる権限とAPIリクエストのレート制限が返されます。

POST/api/v1/auth/token

cURLリクエスト 

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/token \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"ttl_seconds":1800}'

レスポンス 

{
  "data": {
    "access_token": "EXAMPLE_ACCESS_TOKEN",
    "expires_at": "2026-01-01T12:15:00Z",
    "expires_in": 1800,
    "permissions": [
      "orders.order:read"
    ],
    "rate_limits": {
      "auth_per_minute": 1,
      "read_per_minute": 2,
      "write_per_minute": 15
    },
    "token_type": "Bearer",
    "warnings": []
  },
  "meta": {
    "request_id": "example"
  }
}

APIリクエストを送信

APIリクエストには取得したトークンを使ってください。ストアのリクエスト制限を超えないようにしてください。各操作を利用できるかどうかは、プランの権限にもよって決まります。

リクエストの言語やマーケットを選ぶ必要がある場合は、ストアのコンテキストを取得してください。利用可能な言語とマーケット、およびそれぞれのコードと識別子が返されます。

トークンを取り消す

トークンの取り消しは任意です。一度限りの作業に使う場合は、作業終了後に取り消すことをおすすめします。手動で取り消さなければ、トークンは設定された有効期間の終了まで使えます。その後は使用できなくなります。

POST/api/v1/auth/revoke

cURLリクエスト 

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/revoke \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"access_token":"EXAMPLE_ACCESS_TOKEN"}'

レスポンス 

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}