APIを利用してギフト発行を行う場合には、キャンペーン開始までに、ギフトを発行する貴社システムの開発および改修を行っていただく必要がございます。
・APIのご利用には弊社内の確認がございます。
・場合によっては、所定のお手続きのご連絡またはご利用をお断りすることがございますのであらかじめご了承ください。
・ご利用のお断りによる開発中断または停止に対する補償は致しかねます。
申し込み〜請求までの流れ
APIをご利用いただく場合の流れは以下のとおりです。
ご利用をご希望の際は導入のサポートをいたしますので事前にお問い合わせください。
また、開発ご担当者様向けにAPI仕様についてのよくある質問をまとめておりますので、必要に応じて以下のページを開発ご担当者様にご共有ください。
API連携の準備
お申し込みが完了したら、以下の手順に沿ってAPI連携に必要な情報の取得や設定を行い、API連携のご準備を進めていただくことが可能になります。
※同時に弊社内にて本記事冒頭に記載の弊社内での所定の確認を行います。必要に応じてご連絡いたしますので書類提出などの対応を依頼する際にはご協力をお願いいたします。
1)サイドバーの「発行情報」をクリックし、APIトークンの画面を開きます。
コピーボタンをクリックすると、必要なAPIトークンを取得することができます。
2)「IPアドレス制限」タブより、API利用をされる貴社のIPアドレスを設定します。
①「+許可するIPアドレスを追加」ボタンをクリックします。
②IPアドレスを入力します。
IPアドレスの設定に関するご注意は以下のとおりです。
- セキュリティの観点から、ホワイトリスト形式(登録したアドレスのみアクセス許可される)の制限となっており、許可したIPアドレス以外の全ての通信を遮断する設定になっています。
- セキュリティの観点からIPアドレス制限を推奨しております。制限を設けたくない場合、全通信を許可する設定が必要となりますので、弊社担当までご相談ください。
- IPアドレス制限を行っておらず、お客様起因で「APIトークン」「gift_card_config_code」「giftee_box_config_code」が外部へ流出した場合、不正に発行されたギフトについてもすべて請求対象となりますので、API情報のお取り扱いにはご注意ください。
- 固定IPをお持ちでない場合は、弊社担当までご連絡ください。
ギフト情報の取得
審査の完了後にギフト発行に必要な「gift_card_config_code」「giftee_box_config_code」の取得が可能になります。
管理画面のAPI「ご利用ギフト」もしくは「発行情報」タブより、「gift_card_config_code」「giftee_box_config_code」をコピーして取得してください。
※発行開始日以降にリクエストされた分についてはすべて請求対象となります。
API連携についてよくあるご質問
・API利用のキャンペーン完了後の流れ
キャンペーン開始後の実績確認やご請求についてご確認ください。
・「APIテスト案件」を使ったテスト方法
本番のキャンペーンの前に疎通のテストを行うことができます。