{"_id":"5544d76bd8833c0d00582816","version":{"_id":"5544d76ad8833c0d00582801","__v":1,"project":"55227389b4a0de0d00de7e28","forked_from":"55227389b4a0de0d00de7e2b","createdAt":"2015-05-02T13:55:54.059Z","releaseDate":"2015-05-02T13:55:54.059Z","categories":["5544d76ad8833c0d00582802","5544d76ad8833c0d00582803","5544d76ad8833c0d00582804","5544d76ad8833c0d00582805","5544d76ad8833c0d00582806"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4.0"},"project":"55227389b4a0de0d00de7e28","category":{"_id":"5544d76ad8833c0d00582803","pages":["5544d76bd8833c0d00582815","5544d76bd8833c0d00582816","5544d76bd8833c0d00582817","5544d76bd8833c0d00582818","5544d76bd8833c0d00582819","5544d76bd8833c0d0058281a","5544d76bd8833c0d0058281b","5544d76bd8833c0d0058281c","5544d76bd8833c0d0058281d","5544d76bd8833c0d0058281e","5544d76bd8833c0d0058281f","5544d76bd8833c0d00582820","5544d76bd8833c0d00582821","5544d76bd8833c0d00582822","5544d76bd8833c0d00582823"],"__v":1,"project":"55227389b4a0de0d00de7e28","version":"5544d76ad8833c0d00582801","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-07T08:14:54.351Z","from_sync":false,"order":1,"slug":"api","title":"API"},"user":"552342f6e20da719000e7925","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-07T09:03:21.636Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"`Auth`はログインフォームを経由することなく、ショップフロントへの証認アクセスを取得するために使用する特殊なエンティティです。\n\nこのエンティティは`POST` リクエストのみサポートします。\nレスポンスとして、生成されたセッションキーとリンクを返します。\n\nこのリンクは、リダイレクトされる`redirect_url` パラメータを含むことができます。\n[block:api-header]\n{\n  \"type\": \"link\",\n  \"title\": \"URL\"\n}\n[/block]\n\n[block:html]\n{\n  \"html\": \"http://example.com/api/auth\"\n}\n[/block]\n認証キーとリンクを問い合わせします。`POST` のみサポート。\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST パラメーター\"\n}\n[/block]\nこのAPIでサポートされるパラメータは以下の通りです。\n(必須のパラメータには`*`がついています)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"以下に記載の無いパラメータは無視されます。\",\n  \"title\": \"ヒント\"\n}\n[/block]\n- *emai* `*` ユーザーのログイン用Eメールアドレス。管理者のものでも顧客のものでも可。\n登録されてない電子メールであれば、404エラーが表示されます。\n- `redirect_url` リダイレクトするURL。\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"戻り値\"\n}\n[/block]\n- *key* —認証されたユーザーのセッションキー\n\n- *link* —ユーザーがたどる認証されたリンク。このリンクはセッションキーを含んでいます(`ekey`パラメーターとして)。 リクエストに`redirect_url`パラメータがある場合、リンクは`redirect_url`パラメータを含んでおり、ユーザーはリダイレクトされます。","excerpt":"","slug":"auth","type":"basic","title":"Auth"}
`Auth`はログインフォームを経由することなく、ショップフロントへの証認アクセスを取得するために使用する特殊なエンティティです。 このエンティティは`POST` リクエストのみサポートします。 レスポンスとして、生成されたセッションキーとリンクを返します。 このリンクは、リダイレクトされる`redirect_url` パラメータを含むことができます。 [block:api-header] { "type": "link", "title": "URL" } [/block] [block:html] { "html": "http://example.com/api/auth" } [/block] 認証キーとリンクを問い合わせします。`POST` のみサポート。 [block:api-header] { "type": "post", "title": "POST パラメーター" } [/block] このAPIでサポートされるパラメータは以下の通りです。 (必須のパラメータには`*`がついています) [block:callout] { "type": "info", "body": "以下に記載の無いパラメータは無視されます。", "title": "ヒント" } [/block] - *emai* `*` ユーザーのログイン用Eメールアドレス。管理者のものでも顧客のものでも可。 登録されてない電子メールであれば、404エラーが表示されます。 - `redirect_url` リダイレクトするURL。 [block:api-header] { "type": "basic", "title": "戻り値" } [/block] - *key* —認証されたユーザーのセッションキー - *link* —ユーザーがたどる認証されたリンク。このリンクはセッションキーを含んでいます(`ekey`パラメーターとして)。 リクエストに`redirect_url`パラメータがある場合、リンクは`redirect_url`パラメータを含んでおり、ユーザーはリダイレクトされます。