アカウントAPI
pfos-ID のアカウントAPI の説明です。いまは、ログインなしで使える2つの API があります。
プログラム向けの説明もあります。
- OpenAPI
- https://id-staging.pfos.school/api/openapi.json
- API の一覧
- https://id-staging.pfos.school/.well-known/api-catalog
GET /api/v1/health
pfos-ID が動いているかを確かめます。
{
"status": "ok"
}GET /api/v1/handles/{handle}
@ID が空いているかを確かめます。{handle} には、@ を除いた @ID を入れます。
@ID は @ を除いて6〜32文字で、英小文字（a〜z）・数字・_ が使えます。先頭は英字です。大文字は小文字に、全角の英数字は半角にしてから確かめます。
{
"handle": "taro_pfos",
"available": false,
"reason": "unavailable"
}| reason | 意味 |
|---|---|
| （なし） | 空いている（"available": true） |
invalid | 決まりに合わない。detail に理由が入る |
reserved | 予約語で、だれも使えない |
unavailable | 使われている、または保護中（どちらかは区別しない） |
| detail | 意味 |
|---|---|
too_short | 6文字より短い |
too_long | 32文字より長い |
bad_start | 先頭が英字でない |
bad_char | 使えない文字がある |
自分が手放した @ID を、ログインした状態で確かめると、"available": true と "reclaim": true を返します。
呼びすぎると 429 を返します。Retry-After の秒数だけ待ってから、もう一度試してください。