提供Web API(SS版)①:ログイン

※LinkPrint CLOUD Web APIの概要や本記事内に記載されている用語についての説明はこちらをご確認ください。

ログイン

各APIで使用するアクセストークンの情報を取得するため、開発会社様用のLinkPrint CLOUD 開発版アカウントと連携している、利用会社様用のLinkPrint CLOUD ユーザ版のログイン情報を使用しログインをします。

URL https://www.lpcloud.jp/smartapi_s/login/
POST情報
キー
*userid ログインID
*password パスワード
*ss_auth_code SS版認証コード
戻り値

json⽂字列で返します。

キー
access_token ログインが成功となった場合に値を返す。
multi_auth ワンタイムパスワードが必要な場合は「need_onetime_password」を返す。不要な場合は空を返す。
otid ワンタイムパスワードが必要な場合に値を返す。ワンタイムパスワードの値の確認時にこの値を利用する。
oths ワンタイムパスワードが必要な場合に値を返す。ワンタイムパスワードの値の確認時にこの値を利用する。
msg エラーが発生した際のエラーメッセージを返す。

「*」 このマークが付いている項目は必須項目です。

開発会社側で、ログイン情報を把握している場合は、ログインID・パスワードの文字列を上記URLにPOSTしてください。ログイン情報が不明な場合は利用者側がログイン情報を入力できるログイン画面をシステム内に用意していただく必要があります。

ログインIDとパスワードの情報が一致すれば、ログイン成功となり、「access_token」の情報が返ります。この情報は他のAPIを利⽤する際に必要です。

ログインに失敗した場合は、「msg」の情報を確認し、ログイン情報を確認してください。

多要素認証

ログインIDとパスワードの情報が一致した場合、次に設定した多要素認証の情報を検証します。

認証方法 認証
1.+IPアドレス アクセス元のIPアドレスが指定されたIPアドレスであれば認証完了
2.+メール認証 ユーザ情報に登録されたメールアドレスにワンタイムパスワードを送付
3.+IPアドレス/メール認証 1,2 どちらも検証する
4.+IPアドレス or メール認証(IP優先) 1が認証できなかった場合に2を実⾏しワンタイムパスワードを送付

 

メール認証が設定されている場合、対象のメールアドレス宛にワンタイムパスワードが送付されます。送付されたワンタイムパスワードを使⽤し、再度ログインを実⾏します。

URL https://www.lpcloud.jp/smartapi_s/login/
POST情報
キー
*userid ログインID
*otid 上記の返り値「otid」
*oths 上記の返り値「oths」
*onetime_password メール受信したワンタイムパスワード
*ss_auth_code SS版認証コード
戻り値

json⽂字列で返す

キー
access_token ログインが成功となった場合に値を返す。
msg エラーが発生した際のエラーメッセージを返す。

多要素認証でメール認証が利用されている場合は、ワンタイムパスワードが発行されます。発行されたワンタイムパスワードを入力できる画面をシステム内に用意していただく必要があります。

 

取得した「access_token」の情報は他のAPIで利用しますので、システム内に保管していただくようにお願いします。

「access_token」の有効期限

「access_token」の有効期間は1日となります。「access_token」発行から1日経過後は再度ログインが必要となります。

各APIに対しての最終アクセスから30分間は、同じログインIDを使ってログインをすることはできず、新規の「access_token」は取得ができません。 ログアウト用のAPIがございます。ログアウトを実⾏すると同じログインIDを使ってログインが可能となります。