FrontPage

ユーザーAPI/ユーザー作成

API情報

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

概要

モバイルダイエットに新しいアカウントを作成する。

パラメーター

引数名必須内容
v1(固定)int定数必須バージョン番号
現在は1
cBn(固定)string定数必須コマンド
Bn = BBAPIを呼び出す
CategoryURG(固定)string定数必須オペレーションカテゴリー
URG = コーポレートアカウントマネージャー
Operationpoo(固定)string定数必須オペレーション
poo = PUTオペレーション
AppKeyアプリケーションキーstring必須アプリケーションキーペアのアプリケーションキー
IDseed認証シードstring必須認証に使う毎回変わるランダムの文字列
IDval認証ハッシュ値hash必須sha1(アプリケーションシークレット+認証シード)の値
IDprivateプライベートIDstring任意クライアントサイドのID
flag_autoidフラグ:loginid/passwordの自動生成string任意許可されていればログインIDとパスワードを自動生成する
uid要求ログインIDstring設定による作成するログインID
ログインIDの発行が必須の場合は必ず送出
password要求パスワードstring設定による作成するログインパスワード
ログインIDの発行が必須の場合は必ず送出
Formatjson,yaml,xmlstring定数任意出力フォーマット指定
省略時json(またはアプリケーションキー毎に指定のフォーマット)
CharsetUTF-8,SJIS,EUC-JPstring定数任意出力文字コード指定・省略時UTF8
出力フォーマットjson,xml時は常にUTF-8

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

ログインIDに対する規制

文字列長: 6文字以上64文字未満
使用可能文字: 0-9A-Za-z@_-.

パスワードに対する規制

文字列長: 6文字以上64文字未満
使用可能文字: 0-9A-Za-z@*+!.&#$|\'%_-`{}=?:

返値

変数名内容
api_resultbooleanAPI実行結果
true:成功 false:失敗
api_rescodeintegerAPI結果コード
api_reasonstringAPI結果文字列
useridstring作成されたユーザーのモバイルダイエットID
プライベートIDが送出された場合で、既存のアカウントがあった場合は、既存のモバイルダイエットID
既存のアカウントが複数あった場合には、既存のモバイルダイエットIDを列挙した配列
allianceidstringアカウントの属するアライアンスID
複数の場合は配列
loginidstringログインIDが自動生成された場合、その値
passwordstringパスワードが自動生成された場合、その値

JSONの例

{
	"api_result":true,
	"api_rescode":1,
	"userid":"U8d387b5452f15b057104ed7c",
	"allianceid":"IMD",
	"loginid":"qojzpsrhyqdi",
	"password":"gmkkcuym"
}

XMLの例

<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <api_result>1</api_result>
    <api_rescode>1</api_rescode>
    <userid>U9544c49952f15b274aa6e92d</userid>
    <allianceid>IMD</allianceid>
    <loginid>hhbcknlctzvy</loginid>
    <password>jkzfzmkj</password>
  </response>

サンプル

PHPサンプル サンプル/PHP/ユーザーAPI/ユーザー作成

バージョン

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

Version1
Revision1
Editorwest

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