API 키 만들기

POST

/api/v1/stations/{station_id}/api-keys

curl --request POST \
  --url https://dev.api.endueos.com/api/v1/stations/stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "ci" }'

• 개발 환경
• 로컬 스택 — local/up.sh
• 운영 — 예정, 아직 열지 않았다

비밀값은 이 응답에만 나온다. 사용자 JWT 로만 부를 수 있다.

가이드 — 인증과 신원

인증

• Bearer 토큰 — 사용자 JWT 또는 osk_ 키
• X-API-Key 헤더 — osk_ 키

파라미터

경로 파라미터

station_id

필수

string

/^stn_[0-9A-HJKMNP-TV-Z]{26}$/

예시

stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC

요청 본문^필수

Media typeapplication/json

object

name

필수

string

>= 1 characters <= 100 characters

예시

{
  "name": "ci"
}

응답

201

비밀값이 든 응답 — 캐시하지 않는다.

Media typeapplication/json

object

data

필수

object

api_key

필수

object

api_key_id

필수

string

/^akey_[0-9A-HJKMNP-TV-Z]{26}$/

station_id

필수

string

/^stn_[0-9A-HJKMNP-TV-Z]{26}$/

name

필수

string

key_prefix

필수

비밀값의 앞 9자 — 목록에서 구분하는 용도.

string

status

필수

string

허용 값: active revoked

last_used_at

필수

Any of:

string

string format: date-time

null

null

created_at

필수

string format: date-time

revoked_at

필수

Any of:

string

string format: date-time

null

null

secret

필수

osk_ + hex 64자. 이 응답에서만 볼 수 있다.

string

meta

필수

object

request_id

필수

string

timestamp

필수

string format: date-time

duration

서버 처리 시간(ms).

integer format: int32

예시

{
  "data": {
    "api_key": {
      "api_key_id": "akey_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
      "station_id": "stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
      "status": "active"
    }
  }
}

응답 헤더

Cache-Control

필수

string

허용 값: no-store

400

요청 형식이 틀렸다 — VALIDATION_ERROR(details.errors[]) 또는 BAD_REQUEST. 본문은 오류 봉투.

401

인증이 없거나 무효다 — UNAUTHORIZED. 본문은 오류 봉투.

403

이 인증 수단으로는 못 하는 일이다 — FORBIDDEN (예: API 키로 클라우드 기기 만들기). 본문은 오류 봉투.

404

없거나 내 것이 아니다 — *_NOT_FOUND. 본문은 오류 봉투.

409

지금 상태와 충돌한다 — 코드는 위 설명을 본다. 본문은 오류 봉투.

429

한도를 넘었다 — Retry-After 초 뒤에 다시. 본문은 오류 봉투.

500

서버 오류 — INTERNAL_ERROR. 본문은 오류 봉투.

503

의존 서비스에 닿지 못했다 — 잠시 뒤 다시. 본문은 오류 봉투.