このセクションの記事

もっと見る

WEB-API ユーザ認証について

Avatar
ツバイソサポート
  • 更新
フォローする

ツバイソIDとパスワードを使用してユーザ認証を行います。

成功の可否(result)と、認証キー(authenticity_token)、及び成功に失敗した場合、エラーメッセージ(error)を返します。

authenticity_tokenは、ユーザー認証が必要なAPIを呼び出す時に使用します。 なお、authenticity_token の値は発行されてから一定の時間のみ有効です。

ログインをして、そのままログアウトせずに別のツバイソIDとパスワードを /auth/auth に送った場合、認証の可否に関わらず、既にログイン済のユーザはログアウト処理されます。

■認証時のAPI通信プロトコル

HTTPS POST

■認証URL

https://tsubaiso.net/auth/auth

■事前認証

このメソッドは事前の認証は不要です。

■パラメータ

id (必須) : ツバイソID

pw (必須) : パスワード

cd (必須) : 法人コード

dm (必須) : ドメイン

■リクエスト・レスポンス例

◆リクエスト

https://tsubaiso.net/auth/auth?id=testid&pw=testpassword&cd=1&dm=CL_ADMIN

◆レスポンス

<?xml version="1.0" encoding="UTF-8"?>
<envelope xmlns="http://tsubaiso.jp/2009">
<authenticity_token>q4m6f+DwYJQYkPsJxEjn52h5PciRtMfGnrTuSE2e2Uw=</authenticity_token>
  <created_at>2011-10-14</created_at>
  <entry>
    <result>1</result>
  </entry>
</envelope>

◆リクエスト

https://tsubaiso.net/auth/auth?id=testid&pw=testpassword&cd=1&dm=NODOMAIN

◆レスポンス

<?xml version="1.0" encoding="UTF-8"?>
<envelope xmlns="http://tsubaiso.jp/2009">
  <authenticity_token>hpRcXEkQHKWdv7FWwwBMOV2afWfG1JJHp0DXKvQ18Pk=</authenticity_token>
  <created_at>2011-10-14</created_at>
  <entry>
    <result>0</result>
    <error>Something wrong.</error>
  </entry>
</envelope>

authenticity_token は以降のリクエスト時に付与して下さい。

result は認証がされた場合には 1 を、それ以外は 0 を返します。

 

* ツバイソID, パスワード, 法人コード, ドメインの何れかが許可されていない場合には、

一律で error に Something wrong. のエラーメッセージを返します。

システム上のトラブルの際には

Server troubled. のエラーメッセージを返します。

関連記事