Tenant Contract API

ユーザー企業様と御社サービス間での契約処理に関するAPIです。

API

OPTiM Store では、契約処理の自動化用に下記のAPIを用意しています。

要素技術

本 API では、HTTP Request Body に署名付き JSON を付与した上で、御社サービス側の Tenant Contract API Endpoint に HTTP POST Request を送信します。

署名付き JSON 生成のため、以下の仕様を利用しています。

  • JSON Web Token (JWT)
    • JSON データを Token 化するための仕様です。
    • URL Safe な Encode 方式と、広く一般的に Token に必要となる属性の定義を行っています。
  • JSON Web Signature (JWS)
    • JWT 等の JSON データに署名を付与するための仕様です。
  • JSON Web Key (JWK)
    • 公開鍵や秘密鍵を JSON 形式で表現するための仕様です。
  • JSON Web Key (JWK) Thumbprint
    • 個々の JWK 鍵の識別子を重複なく生成する際などに利用する仕様です。

JWT と JWS に関しては、以下の翻訳版も参考にしてください。

御社サービス側では署名検証のため JWT/JWS ライブラリを利用することを推奨します。各言語ごとの JWT/JWS ライブラリは、以下のサイトにまとめられているので参考にしてください。

以下に主要各言語で上記4つの RFC をサポートしているライブラリをリストアップします。

また上記ライブラリを使って OPTiM Store で必要な操作を行うチュートリアル集を以下にまとめております。 一部のライブラリについては、こちらでサンプルコード等もご紹介しています。