REST API 会員API
最終更新日 2015-9-1

会員API共通仕様

共通仕様

共通仕様

共通リクエスト

共通ヘッダ

キー名 説明 備考
X-APPIARIES-TOKEN アクセストークン(*1)を指定します。  

共通クエリ

キー名 説明 備考
access_token アクセストークン(*1)を指定します。
proc create 省略可能。
get true もしくは falseを指定します。(*2) 省略可能。省略の場合falseがデフォルト

(*1) 〜 アクセストークンは利用するREST APIに応じて、ストアトークン、アプリトークンのいずれかを指定ください。アプリトークンはコントロールパネルのダッシュボードより確認できます。また、ヘッダX-APPIARIES-TOKENまたはクエリaccess_tokenのいずれかで指定が可能ですが、ヘッダでの指定が可能の場合セキュリティ上ヘッダで指定するようにしてください。

(*2) 〜 get=trueを指定の場合、操作対象のデータをレスポンスコンテントで返却しますが、利用するメソッドにより挙動に差異があります。

操作 get=trueの場合の挙動
登録(メソッドPOST) すべての登録情報を返却します。
参照(メソッドGET) すべての登録情報を返却します。
部分更新(メソッドPATCHまたはPOSTでproc=patch) 更新されたキーと値のみを返却します。

共通エラー

REST APIを利用中にエラーが発生した場合は、HTTPステータスコード40xまたは50xを返却します。
エラー内容はHTTPステータスコードにより判別しますが、一部のHTTPステータスコード(409, 422, 423)に関しては、より詳細なエラーコードをレスポンスコンテント(JSON形式)で返却します。

HTTPステータス

ステータスコード 説明 レスポンスコンテント
400 リクエストコンテント形式が間違っています。
401 認証エラーが発生しました。
403 アクセス権限が不足しています。
409 リクエストした値が重複しています。 有り
412 コントロールパネル / 基本設定メールアドレスの登録設定しないになっている。 有り
422 バリデーションエラー。 有り
423 アカウントロックが発生しました。 有り
500 予期しないサーバーエラーが発生しました。
507 仕様可能データ容量超過。

エラーコンテント

キー名 説明 データ型 備考
_error HTTPステータス409または422の場合、
エラーコードがString配列として返却されます。
Array
_invalid_name HTTPステータス422 の場合、
エラーの原因となったキー名がString配列として返却されます。
Array

エラーコード

エラーコード値 分類 エラーのあるリクエストキー エラー内容
0010101 アカウント N/A 認証失敗しました。
0010103 アカウント N/A アカウントロックが発生しました。
0010104 アカウント N/A アカウントロック状態です。
0010105 アカウント N/A 多数の認証失敗が発生したアカウントロック状態です。
0010304 パスワード pw 指定できない文字列。
0020001 コンテント N/A 必須キーが指定されていません。(*3)
0020002 コンテント N/A 予約語(*4)が指定されています。
0020003 コンテント N/A 更新不可能キーが指定されています。
0020201 ログインID login_id “”またはnullが指定されている。
0020202 ログインID login_id String以外が指定されている。
0020203 ログインID login_id LF, CR, TABを除く制御文字が含まれている。
0020209 ログインID login_id 重複しています。
0020301 パスワード pw nullまたは空白
0020302 パスワード pw String以外が指定されている。
0020304 パスワード pw LF, CR, TABを除く制御文字が含まれている。
0020401 メールアドレス email “”またはnullが指定されている。
0020402 メールアドレス email String以外が指定されている。
0020405 メールアドレス email 形式が間違っている。
0020409 メールアドレス email 重複しています。

(*3) 〜 レスポンス例。

(*4) 〜 予約語。 アンダースコア(_)からはじまるキー名。

アカウントロック機能

不正ログインの防止のため、会員管理機能はアカウントロックを有しています。
ここでは、アカウントロックの発生条件。その際のレスポンスフォーマット、アカウントロック時間に言及します。

アカウントロック発生条件

10回以上ログインに失敗した場合(REST APIログインする )、アカウントロックが発生します。

レスポンス

アカウントロック発生時(エラーコード001010300101040010105)は、共通エラーと異なり以下のフォーマットでレスポンスが返却されます。

HTTPステータス

説明

ステータスコード
423 アカウントロックが発生しました。

コンテント

キー名 説明 データ型 備考
_state ロック状態。(下部の表を参照) String
_error エラーコードがString配列として返却されます。 Array

ロック状態

説明
locked アカウントロックが発生しました。
locking アカウントロックが発生しています。

 

上記フォーマットに沿ったレスポンスサンプルは以下のようになります。

メールアドレス認証の設定有無によるアカウントロック発生時の挙動の違い

メールアドレス認証を設定するまたは設定しないによりアカウントロック発生時の挙動が異なります。

 

メールアドレス認証設定するの場合

アカウントロック発生時に 確認済みのメールアドレスに対して、アカウントロック解除用URLが記載されたメールが送信されます。アカウントロック解除URLをブラウザで開くことで、アカウントロックが解除されます。

 

メールアドレス認証設定しないの場合

アカウントロック解除用のメールが送信されません。

 

アカウントロックのロック時間

上記はアカウントロックを能動的に解除する方法に関して記述しましたが、アカウントロック発生後、指定時間経過すると自動的に解除されます。

アカウントロック時間 30分