Admin API:パスワードを決めるリンク
メールで届いたリンクの中身を確かめ、パスワードを決める操作です。共通の決まり(認証、エラーの形、日時)は Admin API のリファレンス にあります。
例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。
| 操作 | メソッドとパス |
|---|---|
| パスワードを決めるリンクの内容 | GET /admin/api/password-links/{token} |
| リンクでパスワードを決める | POST /admin/api/password-links/{token} |
パスワードを決めるリンクの内容
Section titled “パスワードを決めるリンクの内容”GET /admin/api/password-links/{token}- ログイン:不要
パラメーター:
| 名前 | 場所 | 型 | 必須 | 決まり | 説明 |
|---|---|---|---|---|---|
token |
パス | 文字列 | ○ | リンクのトークン |
返る値:
| 状態 | 本文 |
|---|---|
200 |
PasswordLinkInfo(application/json) |
うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。
例:
curl "https://<ホスト名>.hakocms.net/admin/api/password-links/<token>"リンクでパスワードを決める
Section titled “リンクでパスワードを決める”パスワードを決める。ほかのセッションは消し、この場でログインした状態にする。
POST /admin/api/password-links/{token}- ログイン:不要
パラメーター:
| 名前 | 場所 | 型 | 必須 | 決まり | 説明 |
|---|---|---|---|---|---|
token |
パス | 文字列 | ○ | リンクのトークン |
リクエストの本文(application/json):
| 名前 | 型 | 必須 | 決まり | 説明 |
|---|---|---|---|---|
password |
文字列 | ○ |
返る値:
| 状態 | 本文 |
|---|---|
200 |
MeResponse(application/json) |
うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。
例:
curl -X POST "https://<ホスト名>.hakocms.net/admin/api/password-links/<token>" \ -H "Content-Type: application/json" \ -d '{ "password": "<password>"}'