![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
バイパスキーAPI/バイパスキー認証
| 名称 | アクセスキー認証 |
|---|---|
| APIバージョン | 1 |
| 認証タイプ | クライアント認証 |
| URL | https://(APIサーバー名)/services/api/(アクセスコード)/ |
| Method | POST |
| データ形式 | application/x-www-form-urlencoded |
バイパスキーを認証しcookie値を取得する。
| 引数名 | 値 | 型 | 必須 | 内容 |
| v | 1(固定) | int定数 | 必須 | バージョン番号 現在は1 |
| c | Bn(固定) | string定数 | 必須 | コマンド Bn = 非ユーザーAPIを呼び出す |
| Category | BY2(固定) | string定数 | 必須 | オペレーションカテゴリー BY2 = バイパスキー |
| Operation | god(固定) | string定数 | 必須 | オペレーション god = GETオペレーション |
| AppKey | アプリケーションキー | string | 必須 | アプリケーションキーペアのアプリケーションキー |
| IDseed | 認証シード | string | 必須 | 認証に使う毎回変わるランダムの文字列 |
| IDval | 認証ハッシュ値 | hash | 必須 | sha1(アプリケーションシークレット+認証シード)の値 |
| password | バイパスキー | string | 必須 | バイパスキーの値 |
| Format | json,yaml,xml | string定数 | 任意 | 出力フォーマット指定 省略時json(またはアプリケーションキー毎に指定のフォーマット) |
| Charset | UTF-8,SJIS,EUC-JP | string定数 | 任意 | 出力文字コード指定・省略時UTF8 出力フォーマットjson,xml時は常にUTF-8 |
認証パラメーターAppKey,IDseed,IDvalについては、API認証を参照
出力指定パラメーターFormat,Charsetについては、出力フォーマットを参照
| 変数名 | 型 | 内容 |
| api_result | boolean | API実行結果 true:成功 false:失敗 |
| api_rescode | integer | API結果コード |
| api_reason | string | API結果文字列 |
| userid | string | 対象のユーザーID |
| entryid | string | 対象の画像認識キューエントリーID |
| cookie | string | cookie値 |
{
"api_result":true,
"api_rescode":1,
"userid":"U2b4dfd4b4dc74aa65cea0f71",
"entryid":"68a414b956410f8f6be701b6",
"cookie":"mqs:5MzjwChBEUARxWLvdrCEY3lxNioovln4gR8kCb9NMpinjKHH9WBeq0P3sEnw"
}
1 1 U2b4dfd4b4dc74aa65cea0f71 68a414b956410f8f6be701b6 mqs:5MzjwChBEUARxWLvdrCEY3lxNioovln4gR8kCb9NMpinjKHH9WBeq0P3sEnw
PHPサンプル サンプル/PHP/バイパスキーAPI/バイパスキー認証
このドキュメントのバージョン情報
| Version | 1 |
| Revision | 1 |
| Editor | west |
