カテゴリー別アーカイブ: シーケンスAPI

シーケンスAPIリファレンス

シーケンスAPI について説明します

シーケンスAPI

シーケンスAPIへのアクセスには全て SSL を用い、ドメインは、https://api-datastore.appiaries.comを指定します。

相対パスのプレフィクス v1 はAPI バージョンを表しています。

シーケンスAPIを利用するためには、シーケンスコレクションの登録が必要となります。
シーケンスコレクションは、コントロールパネルで登録できます。

シーケンスAPI 機能一覧

実現する操作 HTTPメソッド エンドポイント
シーケンス発行 POST または PATCH /v1/seq/{データストアID}/{アプリID}/{コレクションID}/_issue
シーケンス取得 GET /v1/seq/{データストアID}/{アプリID}/{コレクションID}

シーケンス発行

アプリに対してシーケンス値を発行する

基本仕様

クライアントアプリケーション複数台に対し、シーケンス値を排他的に発行する

HTTPメソッド

POST または PATCH

エンドポイント

/v1/seq/{データストアID}/{アプリID}/{コレクションID}/_issue

リクエスト

ヘッダ

Content-Type application/json
X-APPIARIES-TOKEN アプリトークンまたはストアトークンを指定します

クエリ

クエリ名 備考
proc patch 任意

コンテント

パラメータ名 備考
inc 増減値 必須
n+増減値
※n={コレクションID}.seqのseqフィールドの値
初期値:{コレクションID}.seqのinit_value値
マイナス値を利用する場合は、シーケンスコレクション作成時に”減算を利用する”を選択してください。

レスポンス

ヘッダ

Content-Type application/json

HTTPステータス

ステータスコード 内容
200 成功
400 コンテント未指定。コンテント形式不適切。
401 トークン未指定
403 トークン種別不一致
404 コレクション未作成
422 契約ID不適切
500 予期せぬエラー発生

ステータスコード 422 のとき下記のような JSON 形式でコンテントボディが返却される

エラーコード一覧

エラーコード値 分類 内容
0160001 コンテント全般 コンテント不足
0160002 コンテント全般 コンテント名不適切
0160101 増減値 null, 空白
0160102 増減値 文字列ではない
0160104 増減値 指定できない値

例) curl コマンド

シーケンス取得

シーケンス値を取得する

基本仕様

シーケンス値を取得する
取得するシーケンス値は、リクエストした時点の最終更新値

HTTPメソッド

GET

エンドポイント

/v1/seq/{データストアID}/{アプリID}/{コレクションID}

リクエスト

ヘッダ

Content-Type application/json
X-APPIARIES-TOKEN アプリトークンまたはストアトークンを指定します

クエリ

クエリ名 備考
proc get 省略可

レスポンス

ヘッダ

Content-Type application/json

HTTPステータス

ステータスコード 内容
200 成功
401 トークン未指定。認証失敗。
403 トークン種別不一致
404 コレクション未作成
500 予期せぬエラー発生

コンテント

フィールド名 内容
seq シーケンス値

例)curlコマンド