FrontPage

ユーザーAPI/ユーザー確認

API情報

名称ユーザー確認
APIバージョン1
認証タイプユーザー認証
URLhttps://(APIサーバー名)/services/api/(アクセスコード)/
MethodPOST
データ形式application/x-www-form-urlencoded

概要

モバイルダイエットのユーザーアカウントを検証する。

パラメーター

引数名必須内容
v1(固定)int定数必須バージョン番号
現在は1
cBu(固定)string定数必須コマンド
Bu = ユーザー認証付きBBAPIを呼び出す
CategoryURG(固定)string定数必須オペレーションカテゴリー
URG = コーポレートアカウントマネージャー
Operationvoo(固定)string定数必須オペレーション
voo = VALIDATEオペレーション
AppKeyアプリケーションキーstring必須アプリケーションキーペアのアプリケーションキー
UserAuthユーザー認証タイプstring必須userhashbb
uidモバイルダイエットIDstringuidまたはloginidのいずれか必須ユーザーのモバイルダイエットID
loginidログインIDstringuidまたはloginidのいずれか必須ユーザーのログインID
passwordパスワードハッシュ値hash必須sha1(アプリケーションシークレット+パスワード) の値
Formatjson,yaml,xmlstring定数任意出力フォーマット指定
省略時json(またはアプリケーションキー毎に指定のフォーマット)
CharsetUTF-8,SJIS,EUC-JPstring定数任意出力文字コード指定・省略時UTF8
出力フォーマットjson,xml時は常にUTF-8

認証パラメーターAppKey,UserAuth,uid,passwordについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照

返値

変数名内容
api_resultbooleanAPI実行結果
true:成功 false:失敗
api_rescodeintegerAPI結果コード
api_reasonstringAPI結果文字列

JSONの例

{
	"api_result":true,
	"api_rescode":1,
	"userid":"U8d387b5452f15b057104ed7c"
}

XMLの例


  
    1
    1
    U8d387b5452f15b057104ed7c
  

サンプル

PHPサンプル サンプル/PHP/ユーザーAPI/ユーザー確認

バージョン

このドキュメントのバージョン情報

Version1
Revision1
Editorwest

トップ   差分 履歴 リロード   一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2018-06-22 (金) 07:58:25