본문으로 건너뛰기

API 인증 가이드

인증 키 | API Key

정보

API 를 사용하고자 하시는 경우, 문의 바랍니다. 문의 : biz@omnious.com

OMNICOMMERCE 의 모든 API 는 HTTP 기반의 REST API이며, 사용하기 위해서는 인증키가 필요합니다.

인증키는 솔루션 / Workspace 별로 발급됩니다.
API Key에는 상품 데이타에 대한 관리 권한이 포함되어 있으므로 외부에 노출되지 않도록 주의가 필요합니다.

인증 키 확인 방법

정보

인증키는 마스터 계정 (최초 가입 계정) 에서만 확인이 가능합니다.

OMNICOMMERCE Web 서비스의 상단의 Pool 메뉴를 클릭한 후 Workspace 관리 를 선택합니다.
Workspace 관리 화면에서 인증키 부분의 보기 를 클릭합니다.
아래와 같이 각 API 별 인증키를 확인할 수 있습니다.

사용 방법

HTTP Request Header에 x-api-key 라는 이름으로 값을 전송합니다.

Example. cURL 에서 x-api-key Header

curl --location --request POST '<ENDPOINT URL>' \
--header 'x-api-key: <API KEY>' \
--header 'Content-Type: application/json' \
--data-raw '<JSON BODY>'

Example. Python 에서 x-api-key Header

import requests
res = requests.post(
    '<ENDPOINT URL>', 
    json={
        ## JSON BODY
    }, 
    headers={
        'x-api-key': '<API KEY>'
    }
)

인증 키 | API Key
- 인증 키 확인 방법
사용 방법