API 인증 가이드

인증 키 | API Key

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

• 인증 키는 검색 DB 별로 발급됩니다.

• API Key에는 검색 DB에 대한 관리 권한이 포함되어 있으므로 외부에 노출되지 않도록 주의가 필요합니다.

사용 방법

• 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>'
    }
)