登録ページAPIでは、登録ページに表示する「プラン」をAPIで登録・一覧・更新・削除できます。プランごとの契約者一覧(contractor)も取得できます。
エンドポイント一覧
| 用途 |
メソッド |
エンドポイント |
リクエスト |
主なレスポンス |
| プラン登録 |
POST |
/v1/advance |
Planオブジェクト |
plan_id / url_application / plan |
| プラン一覧 |
GET |
/v1/advance |
なし |
plans |
| プラン取得 |
GET |
/v1/advance/{plan_id} |
なし |
plan_id / url_application / plan |
| プラン更新 |
PUT |
/v1/advance/{plan_id} |
Planオブジェクト |
plan_id / url_application / plan |
| プラン削除 |
DELETE |
/v1/advance/{plan_id} |
なし |
plan_id |
| 契約者一覧 |
GET |
/v1/advance/{plan_id}/contractor |
なし |
contractor |
プラン登録(新規作成)
POST /v1/advance
リクエストは Plan オブジェクト(JSON)です。最低限、contract_type、plan_name、language を指定します。contract_type によって discord_rule または line が必要になる場合があります。
{
"plan_id": "PLAN_ID",
"url_application": "申し込みURL",
"plan": { "Planオブジェクト" }
}
プラン一覧
GET /v1/advance
PlanSummaryオブジェクト
| json_key |
json_type |
description |
| plan_id |
string |
プランID |
| contract_type |
string |
申し込み種別 |
| plan_name |
string |
プラン名 |
| url_application |
string |
申す込みURL |
プラン取得 / 更新 / 削除
GET /v1/advance/{plan_id}
PUT /v1/advance/{plan_id}
DELETE /v1/advance/{plan_id}
更新(PUT)のリクエストは Plan オブジェクトです。
契約者一覧の取得
GET /v1/advance/{plan_id}/contractor
Contractorオブジェクト
status は 2:契約、3:解約、5:待機中、30:不成立を表します。
| json_key |
json_type |
required |
description |
remarks |
| status |
integer |
必須 |
契約状態 2: 契約、3: 解約、5: 待機中, 30: 不成立 |
|
| email |
string |
必須 |
メールアドレス |
|
| name |
string |
必須 |
名前 |
|
| company |
string |
任意 |
会社名 |
|
| contract_date |
string |
必須 |
契約日 |
|
| cancel_date |
string |
任意 |
解約日 |
|
| discord_id |
string |
任意 |
Discord ID |
|
| discord_user_name |
string |
任意 |
Discordユーザー名 |
|
| line_id |
string |
任意 |
Line ID |
|
| line_user_name |
string |
任意 |
Lineユーザー名 |
|
| notes |
NoteValue[] |
任意 |
備考欄 |
|
| affiliate |
Affiliate |
任意 |
アフィリエイト情報 |
|
Planオブジェクト(リクエスト)
Planオブジェクト
| json_key |
json_type |
required |
default |
description |
remarks |
| contract_type |
string |
必須 |
null |
契約種別(email, discord, line) |
|
| provider_name |
string |
任意 |
null |
サービス提供者名 |
|
| plan_name |
string |
必須 |
null |
プラン名 |
|
| label |
string |
任意 |
null |
ラベル |
|
| agreement_terms |
object(AgreementTerms) |
任意 |
null |
同意チェックボックス |
|
| show_discord_account_change |
boolean |
任意 |
null |
ユーザーページのDiscordロール許可フラグ |
|
| discord_rule |
object(DiscordRule) |
|
null |
Discord自動化ルール contract_typeがdiscordの場合は必須 |
|
| line |
object(Line) |
|
null |
Line contract_typeがlineの場合は必須 |
|
| url_redirect_1 |
string |
任意 |
null |
リ受け付け完了時に指定したURLにリダイレクトする |
|
| url_redirect_2 |
string |
任意 |
null |
申し込み完了時に指定したURLにリダイレクトする |
|
| mail_application |
object(Mail) |
任意 |
※ |
申し込み完了メール |
指定しない場合はデフォルトのテンプレートが適用される |
| mail_contract |
object(Mail) |
任意 |
※ |
申し込み完了メール |
指定しない場合はデフォルトのテンプレートが適用される |
| contract_start |
object(ReceptionHours) |
任意 |
null |
販売開始日時 |
|
| contract_end |
object(ReceptionHours) |
任意 |
null |
販売終了日時 |
|
| quantity |
integer |
任意 |
null |
在庫数 |
|
| alert_inventory |
object(InventoryAlert) |
任意 |
null |
在庫アラート |
|
| custom_item_names |
object(CustomItemNames) |
任意 |
null |
項目名のカスタマイズ |
|
| language |
string |
必須 |
※ |
申し込みページの言語 |
ja, en, ptのいずれか |
| free_space |
string |
任意 |
null |
フリースペース |
|
| provider_information |
object(ProviderInformation) |
任意 |
null |
提供者情報 |
|
| contract_flow |
integer |
任意 |
1 |
メールアドレス認証設定 |
1:名前とメールアドレスの取得と決済ページを分けない(デフォルト) 2:名前とメールアドレスの取得と決済ページを分ける |
| display_free_space |
integer |
任意 |
3 |
フリースペースの表示 |
3:お申し込みページとお支払い設定ページに表示(デフォルト) 1:お支払い設定ページのみ |
| disalbe_company_name |
boolean |
任意 |
false |
disalbe_company_name |
デフォルトはfalse |
| use_phone_number |
boolean |
任意 |
false |
電話番号入力フラグ |
デフォルトはfalse |
| notes |
array<object(Note)> |
任意 |
null |
備考欄の名前 |
|
| background_color |
string |
任意 |
null |
背景色 |
|
| additional_address |
array<object(AdditionalAddress)> |
任意 |
null |
受信用メールアドレス追加 |
|
Planで使用する関連オブジェクト
AgreementTermsオブジェクト
| json_key |
json_type |
required |
default |
description |
remarks |
| show_agreement_terms |
boolean |
必須 |
null |
利用規約に同意利用フラグ |
|
| agreement_checkbox_text |
string |
必須 |
null |
利用規約に同意のチェックボックス表記 |
|
| agreement_title |
string |
必須 |
null |
利用規約名 |
|
| agreement_content |
string |
必須 |
null |
利用規約 |
|
Mailオブジェクト
| json_key |
json_type |
required |
default |
description |
remarks |
| bcc |
boolean |
必須 |
null |
BCC送信フラグ |
|
| subject |
string |
必須 |
null |
メール件名 |
|
| body |
string |
必須 |
null |
メール本文 |
|
DiscordRuleオブジェクト
| json_key |
json_type |
required |
default |
description |
remarks |
| trigger |
string |
必須 |
|
トリガー(いつ) |
auto: 申し込み時(自動/登録と同時) manual: 申し込み時(手動/登録後) cancel:解約 |
| action |
string |
必須 |
|
アクション(どうする) |
grant:ロール付与 remove:ロール剥奪 kick:サーバーキック |
| guild_id |
string |
必須 |
|
ギルドID(どのサーバーの) |
|
| target_type |
string |
必須 |
|
channel or role |
|
| role_ids |
string[] |
※ |
|
ロールID(なにを) |
target_type=roleの場合は必須 |
| channel_ids |
string[] |
※ |
|
チャンネルID(なにを) |
target_type=channel の場合は必須 |
| related_role |
boolean |
任意 |
|
関連ロール確認 |
|
Lineオブジェクト
| json_key |
json_type |
required |
default |
constraints |
description |
remarks |
| channel_id |
string |
必須 |
null |
|
チャンネルID |
|
| channel_secret |
string |
必須 |
null |
|
チャンネルシークレット |
|
| add_friend_option |
integer |
任意 |
null |
|
友達追加オプション(null:未使用, 1:通常, 2:強制, それ以外:未使用) |
|
ReceptionHoursオブジェクト
| json_key |
json_type |
required |
default |
constraints |
description |
remarks |
| time |
integer |
必須 |
null |
|
Linux時間 |
|
| message |
string |
任意 |
null |
|
メッセージ |
|
CustomItemNamesオブジェクト
| json_key |
json_type |
required |
default |
constraints |
description |
remarks |
| seller_name |
string |
必須 |
null |
|
販売者 |
|
| purchaser |
string |
必須 |
null |
|
購入者 |
|
| plan_name |
string |
必須 |
null |
|
サービス名 |
|
| name |
string |
必須 |
null |
|
お名前 |
|
| company |
string |
必須 |
null |
|
会社名 |
|
| form_name_1 |
string |
必須 |
null |
|
無料登録フォーム |
|
| form_name_2 |
string |
必須 |
null |
|
こちらの内容でよろしいですか? |
|
| form_name_3 |
string |
必須 |
null |
|
お申し込みが完了しました |
|
| button_1 |
string |
必須 |
null |
|
申し込み |
|
InventoryAlertオブジェクト
| json_key |
json_type |
required |
default |
constraints |
description |
remarks |
| threshold |
string |
必須 |
null |
|
在庫アラート閾値 |
|
| message |
string |
必須 |
null |
|
在庫アラートメッセージ |
|
ProviderInformationオブジェクト
| json_key |
json_type |
required |
default |
constraints |
description |
remarks |
| url_bussiness |
string |
任意 |
null |
|
ビジネスの Web サイト |
|
| url_support |
string |
任意 |
null |
|
サポートの Web サイト |
|
| url_service_terms |
string |
任意 |
null |
|
プライバシーポリシー |
|
| url_privacy_policy |
string |
任意 |
null |
|
利用規約 |
|
| url_special_commercial_law |
string |
任意 |
null |
|
特定商取引法に基づく表記 |
|
Noteオブジェクト
| json_key |
json_type |
required |
default |
constraints |
description |
remarks |
| name |
string |
必須 |
null |
|
備考欄名 |
|
| require |
boolean |
必須 |
null |
|
必須フラグ |
|
AdditionalAddressオブジェクト
| java_field |
json_key |
java_type |
json_type |
required |
default |
constraints |
description |
remarks |
| email |
email |
String |
string |
任意 |
null |
|
メールアドレス |
|
| name |
name |
String |
string |
任意 |
null |
|
表示名 |
|
関連情報