バイパスキーAPI/アクセスキー認証 の変更点

• 追加された行はこの色です。
• 削除された行はこの色です。
• バイパスキーAPI/アクセスキー認証 へ行く。

[[FrontPage]]

&size(24){バイパスキーAPI/バイパスキー認証};

* API情報 [#q6190828]

|~名称|アクセスキー認証|
|~APIバージョン|1|
|~認証タイプ|クライアント認証|
|~URL|https://(APIサーバー名)/services/api/(アクセスコード)/|
|~Method|POST|
|~データ形式|application/x-www-form-urlencoded|

* 概要 [#jfe13a2c]

バイパスキーを認証しcookie値を取得する。


* パラメーター [#ya59d11f]

|引数名|値|型|必須|内容|h
|v|1(固定)|int定数|必須|バージョン番号&br;現在は1|
|c|Bn(固定)|string定数|必須|コマンド&br;Bn = 非ユーザーAPIを呼び出す|
|Category|BY2(固定)|string定数|必須|オペレーションカテゴリー&br;BY2 = バイパスキー|
|Operation|god(固定)|string定数|必須|オペレーション&br;god =  GETオペレーション|
|AppKey|アプリケーションキー|string|必須|アプリケーションキーペアのアプリケーションキー|
|IDseed|認証シード|string|必須|認証に使う毎回変わるランダムの文字列|
|IDval|認証ハッシュ値|hash|必須|sha1(アプリケーションシークレット+認証シード)の値|
|password|バイパスキー|string|必須|バイパスキーの値|
|Format|json,yaml,xml|string定数|任意|出力フォーマット指定&br;省略時json(またはアプリケーションキー毎に指定のフォーマット)|
|Charset|UTF-8,SJIS,EUC-JP|string定数|任意|出力文字コード指定・省略時UTF8&br;出力フォーマットjson,xml時は常にUTF-8|
認証パラメーターAppKey,IDseed,IDvalについては、[[API認証>API認証#authtype_user]]を参照~
出力指定パラメーターFormat,Charsetについては、[[出力フォーマット]]を参照~

* 返値 [#e86e04c1]

|変数名|型|内容|h
|api_result|boolean|API実行結果&br;true:成功 false:失敗|
|api_rescode|integer|API結果コード|
|api_reason|string|API結果文字列|
|userid|string|対象のユーザーID|
|entryid|string|対象の画像認識キューエントリーID|
|cookie|string|cookie値|

** JSONの例 [#i0d756ca]
#html{{
<pre class="brush:xml;">
{
	"api_result":true,
	"api_rescode":1,
	"userid":"U2b4dfd4b4dc74aa65cea0f71",
	"entryid":"68a414b956410f8f6be701b6",
	"cookie":"mqs:5MzjwChBEUARxWLvdrCEY3lxNioovln4gR8kCb9NMpinjKHH9WBeq0P3sEnw"
}
</pre>
}}

** XMLの例 [#c9857f82]
#html{{
<pre class="brush:xml;">
<?xml version="1.0" encoding="UTF-8"?>
  <response>
    <api_result>1</api_result>
    <api_rescode>1</api_rescode>
    <userid>U2b4dfd4b4dc74aa65cea0f71</userid>
    <entryid>68a414b956410f8f6be701b6</entryid>
    <cookie>mqs:5MzjwChBEUARxWLvdrCEY3lxNioovln4gR8kCb9NMpinjKHH9WBeq0P3sEnw</cookie>
  </response>
</pre>
}}

* サンプル [#z5db7844]

PHPサンプル [[サンプル/PHP/バイパスキーAPI/バイパスキー認証]]

* バージョン [#o0becc47]

このドキュメントのバージョン情報
|Version|1|
|Revision|1|
|Editor|west|