템플릿 상세
GET /v1/templates/{templateId}
GET https://api.k-otp.dev/v1/templates/{templateId}개요
Returns one template including the variables schema that templateVariables must satisfy on POST /issue. code is always filled in by the server and must not be sent in templateVariables.
Requires an sk_ secret key; pk_ public keys are rejected with 403.
인증
| 허용 키 | 필요 scope | 대체 허용 scope |
|---|---|---|
sk_ | otp:templates | otp:read, * |
파라미터
| 이름 | 위치 | 타입 | 필수 | 설명 |
|---|---|---|---|---|
templateId | path | string | 예 | Template id from GET /v1/templates. |
응답 (200)
Template detail.
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
templateId | string | 예 | |
name | string | 예 | |
channelSupport | "alimtalk" | "sms"[] | 예 | Channels this template can be sent on. |
body | string | 예 | Message body; #{code} is replaced with the OTP and other #{variable} placeholders with templateVariables. |
variables | object | 예 | Variables accepted in templateVariables when issuing with this template. |
오류 응답
모든 오류는 { defined, code, status, message, data? } 형태입니다. 자세한 내용은 오류를 참고하세요.
| 상태 | code | 설명 |
|---|---|---|
| 400 | BAD_REQUEST | the request failed input validation. message describes the first failing constraint. |
| 401 | UNAUTHORIZED | the Authorization: Bearer credential is missing, malformed, inactive, or rejected by introspection. |
| 403 | FORBIDDEN | the credential lacks otp:templates (or an accepted alias), or a pk_ public key was used. Public keys are limited to issue/verify. |
| 404 | NOT_FOUND | no template with this templateId is available. |
| 409 | CONFLICT | the request conflicts with the current state of the resource. |
| 500 | INTERNAL_SERVER_ERROR | unexpected server failure. Undefined errors (defined: false) use the same envelope. |
| 503 | SERVICE_UNAVAILABLE | credential introspection or a downstream dependency is temporarily unavailable. Retry with backoff. |
요청 예시
curl "https://api.k-otp.dev/v1/templates/otp_default_kr" \
-H "Authorization: Bearer $KOTP_SECRET_KEY"