인증 및 서명

API Key 관리

Markdown으로 보기

API Key 관리 엔드포인트는 JWT 인증만 허용합니다.

API Key 만들기

1POST /v1/private/user/api-key/create
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

요청 매개변수:

매개변수유형필수설명
labelstring네API Key 레이블, 길이 1 - 64
permissions지능아니권한 비트마스크, 기본 1, 범위 1 - 7
ipWhitelist끈[]아니화이트리스트IP 최대 20개 항목까지 가능합니다. 생략할 경우 출처 IP은 제한이 없습니다

요청 예시:

$curl -X POST https://api.6mm.com/v1/private/user/api-key/create \
>  -H "Content-Type: application/json" \
>  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
>  -d '{
>    "label": "external-service-prod",
>    "permissions": 3,
>    "ipWhitelist": ["203.0.113.10"]
>  }'

응답 예시:

1{
2  "code": 0,
3  "message": "success",
4  "data": {
5    "apiKey": "fx_xxxxxxxxxxxxxxxxxxxxxxxx",
6    "apiSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
7  },
8  "requestId": "req-api-key"
9}

apiSecret API Key 가 생성될 때 단 한 번만 반환됩니다. 즉시 비밀 관리 시스템에 저장하세요. 소스 코드 저장소나 로그에 기록하지 마세요.

각 사용자는 최대 30개의 API 키를 만들 수 있습니다.

API 키 목록

1GET /v1/private/user/api-key/list
2Authorization: Bearer YOUR_ACCESS_TOKEN

응답 필드:

필드유형설명
list[].idstringAPI Key ID
list[].labelstring레이블
list[].apiKeystring공 API Key 식별자
list[].permissions지능비트마스크 허가
list[].ipWhitelist끈[]IP 화이트리스트
list[].status지능상태: 1 활성화됨, 0 비활성화됨
list[].lastUsedAtint64마지막 사용 시간
list[].createdAtint64생성 시간

업데이트 API Key

1PUT /v1/private/user/api-key/update
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

요청 매개변수:

매개변수유형필수설명
idstring네API Key ID
labelstring아니새 레이블
permissions지능아니새 허가 비트마스크
ipWhitelist끈[]아니새로운 IP 화이트리스트
status지능아니1 활성화, 0 비활성화

삭제 API Key

1POST /v1/private/user/api-key/delete
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

요청 본문:

1{ "id": "1001" }

모든 API 키를 삭제하세요

1POST /v1/private/user/api-key/delete-all
2Authorization: Bearer YOUR_ACCESS_TOKEN
3Content-Type: application/json

응답 필드:

필드유형설명
deletedint64삭제된 API 키 수