APIを利用してギフト発行を行う場合には、キャンペーン開始までに、ギフトを発行する貴社システムの開発および改修を行っていただく必要がございます。
APIをご利用いただく場合の申込みサイトご利用の手順は以下のとおりです。
１. 申込みサイトの新規アカウント登録
こちらの手順をご参照ください。
２. API仕様書のダウンロード
申込みサイトのヘッダメニューにある「︙」アイコンをクリックし、「API仕様書」よりダウンロードしてください。
アカウント登録完了後に、「APIテスト案件」という項目が表示されます。
テスト案件を作成することで、キャンペーンの前に疎通テストをおこなうことができます。
疎通テストについては、本ページの最後に補足情報として記載しておりますので、ご参照ください。
開発ご担当者様向けにAPI仕様についてのよくある質問をまとめておりますので、必要に応じて以下のページを開発ご担当者様にご共有ください。
3. お申し込み情報の入力
こちらをご参照ください。
４. ギフト利用審査
お申し込みが完了したら、ギフト利用審査へ進めます。
ギフト利用審査とは
こちらの手順をご参照いただき、ギフト利用審査を進めてください。
５. 「APIトークン」の取得
ギフト利用審査が完了しましたら、お申込み済みの案件内の「API＞発行情報、IPアドレス制限」より「APIトークン」の取得およびIPアドレスをご登録ください。
１）サイドバーの「発行情報」をクリックし、APIトークンの画面を開きます。
コピーボタンをクリックすると、必要なAPIトークンを取得することができます。
※「gift_card_config_code」「giftee_box_config_code」はギフト利用審査完了後に表示されます。
２）「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」の取得
後払い依頼書のご提出とギフト利用審査の完了後に「gift_card_config_code」「giftee_box_config_code」の取得が可能になります。
管理画面のAPI「ご利用ギフト」もしくは「発行情報」タブより、「gift_card_config_code」「giftee_box_config_code」をコピーして取得してください。
補足：「APIテスト案件」を使ったテスト方法
アカウント登録完了後、「APIテスト案件」という項目が表示されます。
「テスト案件を作成」ボタンをクリックすると、右側にテスト用の案件が自動生成されます。
検証用環境のご用意はありませんので、このテスト案件ページから「APIトークン」、「gift_card_config_code（giftee_box_config_code）」の取得とIP設定をしていただき、疎通テストを進めてください。
テスト実施の際に不具合がございましたら、弊社担当までご連絡ください。
※実際のキャンペーンを開始されるときには、APIテスト案件で使用したテスト用ではなく、正しい「APIトークン」と「gift_card_config_code」「giftee_box_config_code」をお使いください。
※IPアドレスも、実際のキャンペーンでは正しいものをご設定ください。
ギフトの発行が完了し、キャンペーンが完了しましたらギフトの発行実績をご確認いただくことが可能です。