ユーザーAPI/ユーザー作成
名称 | ユーザー作成 |
---|---|
APIバージョン | 1 |
認証タイプ | クライアント認証 |
URL | https://(APIサーバー名)/services/api/(アクセスコード)/ |
Method | POST |
データ形式 | application/x-www-form-urlencoded |
モバイルダイエットに新しいアカウントを作成する。
引数名 | 値 | 型 | 必須 | 内容 |
v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
c | Bn(固定) | string定数 | 必須 | コマンド Bn = BBAPIを呼び出す |
Category | URG(固定) | string定数 | 必須 | オペレーションカテゴリー URG = コーポレートアカウントマネージャー |
Operation | poo(固定) | string定数 | 必須 | オペレーション poo = PUTオペレーション |
AppKey | アプリケーションキー | string | 必須 | アプリケーションキーペアのアプリケーションキー |
IDseed | 認証シード | string | 必須 | 認証に使う毎回変わるランダムの文字列 |
IDval | 認証ハッシュ値 | hash | 必須 | sha1(アプリケーションシークレット+認証シード)の値 |
IDprivate | プライベートID | string | 任意 | クライアントサイドのID |
flag_autoid | フラグ:loginid/passwordの自動生成 | string | 任意 | 許可されていればログインIDとパスワードを自動生成する |
uid | 要求ログインID | string | 設定による | 作成するログインID ログインIDの発行が必須の場合は必ず送出 |
password | 要求パスワード | string | 設定による | 作成するログインパスワード ログインIDの発行が必須の場合は必ず送出 |
Format | json,yaml,xml | string定数 | 任意 | 出力フォーマット指定 省略時json(またはアプリケーションキー毎に指定のフォーマット) |
Charset | UTF-8,SJIS,EUC-JP | string定数 | 任意 | 出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8 |
認証パラメーターAppKey,IDseed,IDvalについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照
文字列長: 6文字以上64文字未満
使用可能文字: 0-9A-Za-z@_-.
文字列長: 6文字以上64文字未満
使用可能文字: 0-9A-Za-z@*+!.&#$|\'%_-`{}=?:
変数名 | 型 | 内容 |
api_result | boolean | API実行結果 true:成功 false:失敗 |
api_rescode | integer | API結果コード |
api_reason | string | API結果文字列 |
userid | string | 作成されたユーザーのモバイルダイエットID プライベートIDが送出された場合で、既存のアカウントがあった場合は、既存のモバイルダイエットID 既存のアカウントが複数あった場合には、既存のモバイルダイエットIDを列挙した配列 |
allianceid | string | アカウントの属するアライアンスID 複数の場合は配列 |
loginid | string | ログインIDが自動生成された場合、その値 |
password | string | パスワードが自動生成された場合、その値 |
{ "api_result":true, "api_rescode":1, "userid":"U8d387b5452f15b057104ed7c", "allianceid":"IMD", "loginid":"qojzpsrhyqdi", "password":"gmkkcuym" }
<?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/ユーザー作成
このドキュメントのバージョン情報
Version | 1 |
Revision | 1 |
Editor | west |