SuperSaaSのプロモーションAPIでできること

プロモーションAPI
1. プロモーションAPI（2種類）
  1. プロモーション（クーポン）コード情報取得API
  2. プロモーション（クーポン）コード複製API

プロモーションAPI

プロモーションAPIはプロモーション（クーポン）設定に対して、その情報の取得や、既存プロモーション（クーポン）コードの複製登録などを行うことができるAPIです。

現状では限定的な登録情報の参照と、既存のコードをコピー登録ができる程度で、プロモーション（クーポン）の全項目の情報取得や、まっさらでの新規登録、既存登録情報の更新・削除などはできないようです。

なんだか中途半端に感じる実装公開ですね。
活用ニーズとしては、コピーではなく新規登録と修正更新、登録削除が期待される機能のような気がします。
まだ公開されたばかりですし、まだまだ手が入ればと期待したいですね。

プロモーションAPI（2種類）

プロモーション（クーポン）コード情報取得API

www.supersaas.com/api/promotions.型

アカウント内で登録されているプロモーション（クーポン）のIDと名前を全て取得します。

例：
全件の情報を取得する場合
https://www.supersaas.com/api/promotions.型?account=アカウント名&api_key=API Key

部分的に情報を取得する場合
https://www.supersaas.com/api/promotions.型?account=アカウント名&api_key=API Key&limit=最大取得件数&offset=取得開始位置

プロモーションのコードを指定して一つだけ情報を取得する場合
https://www.supersaas.com/api/promotions.型?account=アカウント名&api_key=API Key&id=プロモーションコード

コール用フィールド
（物理名）論理名	概要
型	レスポンスフォーマットとして「json」意外にも「xml」が指定できるようです。
（account）アカウント名	SuperSaaSアカウント名です。
（api_key） API Key	API利用認証用のAPI Keyです。
（limit）最大取得件数	取得するプロモーション（クーポン）情報の最大数を指定できます。省略した場合は全件全て取得します。
（offset）取得開始位置	取得するプロモーション（クーポン）情報の取得開始位置を指定できます。例えば、10と指定すると10件目の情報から取得します。 limitと組み合わせて部分的にページングしながらの取得などが可能です。省略した場合は1件目から情報を取得します。
（id）プロモーションコード	指定したコードのプロモーション情報のみを取得します。

主なレスポンスフィールド
（物理名）論理名	概要
（code）コード情報	対象プロモーション（クーポン）情報のコード項目に設定された情報です。
（description）説明情報	対象プロモーション（クーポン）情報の説明項目に設定された情報です。
（usage）使用数	対象プロモーション（クーポン）が使用された回数情報です。
（id）詳細不明	現状で情報が入っていない不明なレスポンス項目です。公式にも情報が記載されていないので一時的なレスポンスバグかもしれません。

取得できる情報は限定的で、プロモーション（クーポン）で設定されている全ての項目の情報を取得することはできないようです。

プロモーション（クーポン）コード複製API

www.supersaas.com/api/promotions.json

登録されている既存のプロモーション（クーポン）コードを複製します。
このAPIはPOSTメソッドでコールして実行できます。

例：HTTPメソッドはPOSTです
https://www.supersaas.com/api/promotionsjson?account=アカウント名&api_key=API Key&id=複製先プロモーションコード&template_code=複製元プロモーションコード

コール用フィールド
（物理名）論理名	概要
（account）アカウント名	SuperSaaSアカウント名です。
（api_key） API Key	API利用認証用のAPI Keyです。
（id）複製先プロモーションコード	複製して作成するプロモーションコードを指定します。
（template_code）複製元プロモーションコード	複製する元となるプロモーションコードを指定します。

単純に既存のコードを、別名で指定したコードとしてコピー登録するAPIと思われます。
当たり前ですが、新しく登録するコードなのでidには未登録の一意なコード文字列を指定する必要がありますし、コピー元となるのでtemplate_codeには登録されている既存のコードを指定する必要があります。

コード名によってはうまくAPIが動かない場合があるような気がします。
一時的なものだったり、たまたまかもしれませんが、たとえば「test」を含むコード名をコピー元として指定した場合はうまく動きませんでした。

Developer | Promotion API

The Promotion API allows you to create coupon codes for promotions or retrieve usage information about existing coupon codes

（物理名）論理名	概要
（code）コード情報	対象プロモーション（クーポン）情報のコード項目に設定された情報です。
（description）説明情報	対象プロモーション（クーポン）情報の説明項目に設定された情報です。
（usage）使用数	対象プロモーション（クーポン）が使用された回数情報です。
（id）詳細不明	現状で情報が入っていない不明なレスポンス項目です。公式にも情報が記載されていないので一時的なレスポンスバグかもしれません。