API 토큰
지금 부른 토큰 자기 정보(토큰이 묶인 워크스페이스 · 이름 · 범위 · 만료 · 고정 버전). 범위 없이 부른다(데모 토큰 포함).
GET/api/api-tokens/current
토큰을 넣고 처음 확인할 때 쓴다. 로그인(JWT)으로 부르면 404 NOT_FOUND(공개 API 토큰 요청에만 있는 정보)
- ScopeNone (token only)
- Since
1.0.0 - Success
200 - Demo tokenAllowed
id tokens.current
Response 200
GetCurrentApiTokenResponse
namestringrequired발급할 때 정한 이름
tokenPrefixstringoptional토큰을 알아보는 앞부분(afk_ + 4자). 데모 토큰 · 이 칸이 생기기 전에 만든 토큰은 빠진다
scopesAbleflowApiTokenScope[]requiredAbleFlow - 공개 API 토큰 범위(자원 × 읽기/쓰기). 쓰기는 같은 자원의 읽기를 포함한다. 구성원은 읽기만
expiresAtstringoptional없으면 만료되지 않는다(빠진다)
pinnedVersionstringoptionalAbleFlow-Version 헤더가 없을 때 쓸 버전. 없으면 늘 최신(빠진다)
demobooleanrequired데모 토큰(문서 사이트용 · 읽기 전용)이면 true
workspaceIdstringrequired토큰이 묶인 워크스페이스. 다른 워크스페이스의 자원은 404
workspaceNamestringrequired
Errors
9 errors common to every public API
| Status | Code | When |
|---|---|---|
| 400 | UNSUPPORTED_API_VERSION | AbleFlow-Version(또는 토큰 고정 버전)을 맞출 수 없다. detail { requested, supported } |
| 401 | UNAUTHORIZED | Authorization 머리글이 없다(토큰 없음). 공개 API 요청으로 보지 않아 응답에 AbleFlow-Version 머리글이 없다 |
| 401 | INVALID_TOKEN | 토큰이 틀렸거나 폐기됐다(발급자가 워크스페이스를 나가 폐기된 토큰 포함) |
| 401 | TOKEN_EXPIRED | 토큰이 만료됐다 |
| 403 | INSUFFICIENT_SCOPE | 토큰 범위가 모자란다. detail { required } |
| 403 | DEMO_READ_ONLY | 데모 토큰은 GET · HEAD 만 부를 수 있다 |
| 403 | PLAN_FEATURE_REQUIRED | 워크스페이스 요금제에 공개 API 가 없거나 체험이 끝났다(요금제로 막을 때, 데모 토큰 제외). detail { target: PUBLIC_API, reason: PLAN_FEATURE | TRIAL_ENDED, suggestedPlan? } |
| 404 | RESOURCE_NOT_FOUND | 자원이 없거나 토큰이 묶인 워크스페이스 밖이다 |
| 429 | API_RATE_LIMITED | 호출 한도를 넘었다. Retry-After(초) |