本セクションではPMPで提供しているAPIや管理ツールの概要や利用方法を説明します。
具体的なユースケースや処理の流れなどの実装方法はユースケースと実装ガイドのセクションをご覧ください。
提供サービス
管理ツール
コンテンツ管理者や開発者向けに、本番やSTG1,3環境におけるコンテンツ情報やアセット/トークン情報など確認可能な管理ツールを提供しております。
アクセスにはIPアドレスの許可が必要ですので、問い合わせチャンネルにてご連絡下さい。
また、URLは下記「提供機能 」の「管理ツールURL」をご参照下さい。
詳しくは下記資料をご覧ください。
管理ツールガイド提供環境について
環境 | 用途 | PlayMining NFTのURL | APIエンドポイント | 管理ツールURL |
STG3 | 開発環境との連携を意図して用意された環境です。
総合テスト以前のテストはこちらで実施頂くことを想定しています。 | https://contents.stg3.sxi-sierra.com | ||
STG1 | いわゆるステージング環境との連携を意図して用意された環境です。
本番環境に近い環境となっており、NFTのアセット情報など、ほとんど全てのデータが本番準拠で登録されています。
ユーザーへのサービス提供に当たっては、必ずこの環境と連携させた状態で十分なテストを実施し、バグ等がないか検証してください。 | https://contents.stg1.sxi-sierra.com | ||
PROD | 本番環境です。
実際にユーザーへの影響がある処理は、こちらで行われます。 | https://contents.prod1.sxi-sierra.com |
提供APIについて
共通仕様
HTTPリクエストヘッダー
全てのAPIのリクエストで用いる共通のHTTPリクエストヘッダーです。
javascriptContent-type: application/json Authorization: Bearer {API_KEY}
API_KEYはPMPの利用登録をしたあと、管理ツールから払い出します。
HTTPレスポンスステータスコード
全てのAPIの共通仕様として、以下のHTTPレスポンスステータスコードを返します。
コード | 意味 |
200 | 成功 |
400 | Request項目(Header, HttpMethod, Requestパラメータなど)が不正です。 |
401 | コンテンツの認証に失敗しました。 |
403 | バリデーションチェックなどを含むビジネスロジックレベルのエラーが発生しました。 |
500 | サーバー側で想定外のエラーが発生しました。 |
503 | メンテナンス中です。 |
レスポンスのフォーマット
全てのAPIの共通仕様として、以下のトップレベルパラメータを持つJSONオブジェクトが返ります。
パラメータ | 型 | 内容 |
data | object | API特有の結果データが収められたオブジェクト |
result | number | 0(成功)または後述のエラーコード表のエラーコード |
message | string | success(成功)または後述のエラーコード表のエラーメッセージ |
APIリファレンス
各APIの詳細については以下URLを参照ください。
APIリファレンスの参照にはIPアドレスの登録が必要です。利用するIPアドレスをお伝え下さい。
エラーコード表