콘텐츠로 건너뛰기
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"
  }
}