인증 Authentication

DEVDOCS API의 모든 요청은 API 키로 인증합니다. 이 가이드는 키 발급부터 요청 헤더 구성, 토큰 만료 처리까지 한 흐름으로 설명합니다.

API 키 발급

대시보드의 Settings → API Keys에서 키를 발급할 수 있습니다. 발급된 시크릿 키는 다시 표시되지 않으니 안전한 곳에 보관하세요.

ℹ︎ 노트

테스트 키는 sk_test_ 접두사를, 프로덕션 키는 sk_live_ 접두사를 가집니다.

모든 요청의 Authorization 헤더에 Bearer 토큰을 담습니다.

request.sh

bash

curl https://api.devdocs.dev/v3/users \
-H "Authorization: Bearer sk_live_4f3c…" \
-H "Content-Type: application/json"

성공 응답은 200 OK와 함께 JSON 본문을 반환합니다.

response.json

json

{
"id": "usr_8a2f",
"object": "user",
"email": "hana@devdocs.dev",
"verified": true,
"created_at": 1748476800
}

⚠︎ 경고

시크릿 키를 클라이언트 코드나 공개 저장소에 노출하지 마세요. 노출 시 즉시 키를 회전(rotate)해야 합니다.

인증 실패 시 401 Unauthorized가 반환되며, 본문에 에러 코드와 메시지가 포함됩니다.

error.json

json

{
"error": {
"code": "invalid_api_key",
"message": "제공된 API 키가 유효하지 않습니다."
}
}