API利用のお申し込み手順

APIを利用してギフト発行を行う場合には、キャンペーン開始までに、ギフトを発行する貴社システムの開発および改修を行っていただく必要がございます。

 


APIのご利用には弊社内の確認がございます。
・場合によっては、お手続きのご連絡またはご利用をお断りすることがございますのであらかじめご了承ください。
・ご利用のお断りによる開発中断または停止に対する補償は致しかねます。


 

APIをご利用いただく場合の申込みサイトご利用の手順は以下のとおりです。

 

1. 申込みサイトの新規アカウント登録

こちらの手順をご参照ください。

STEP1:新規アカウントの登録

スクリーンショット 2024-02-28 10.53.00.png

 

2. API仕様書のダウンロード

申込みサイトのヘッダメニューにある「︙」アイコンをクリックし、「API仕様書」よりダウンロードしてください。

スクリーンショット 2024-02-28 10.49.52.png

 

アカウント登録完了後に、「APIテスト案件」という項目が表示されます。

テスト案件を作成することで、キャンペーンの前に疎通テストをおこなうことができます。

疎通テストについては、本ページの最後に補足情報として記載しておりますので、ご参照ください。

補足:「APIテスト案件」を使ったテスト方法

 

開発ご担当者様向けにAPI仕様についてのよくある質問をまとめておりますので、必要に応じて以下のページを開発ご担当者様にご共有ください。

・API仕様についてのよくあるご質問

 

3. お申し込み情報の入力

こちらをご参照ください。

STEP2:お申し込み情報の入力①キャンペーン情報

STEP3:お申し込み情報の入力②ギフト情報

 

4. 審査

お申し込みが完了したら、審査に進みます。

ギフトの利用における審査について

 

以下の手順をご参照いただき、審査を進めてください。

STEP4:キャンペーンに使うビジュアルの準備

STEP5:審査

 

5. 「APIトークン」の取得

審査が完了しましたら、お申込み済みの案件内の「API>発行情報、IPアドレス制限」より「APIトークン」の取得およびIPアドレスをご登録ください。

1)サイドバーの「発行情報」をクリックし、APIトークンの画面を開きます。

コピーボタンをクリックすると、必要なAPIトークンを取得することができます。

トークン.png

※「gift_card_config_code」「giftee_box_config_code」は審査完了後に表示されます。

 

2)「IPアドレス制限」タブより、API利用をされる貴社のIPアドレスを設定します。

①「+許可するIPアドレスを追加」ボタンをクリックします。

IPアドレス入力.png

②IPアドレスを入力します。

__________2022-06-29_11.36.58.png

IPアドレスの設定に関するご注意は以下のとおりです。

  • セキュリティの観点から、ホワイトリスト形式(登録したアドレスのみアクセス許可される)の制限となっており、許可したIPアドレス以外の全ての通信を遮断する設定になっています。
  • セキュリティの観点からIPアドレス制限を推奨しております。制限を設けたくない場合、全通信を許可する設定が必要となりますので、弊社担当までご相談ください。
  • IPアドレス制限を行っておらず、お客様起因で「APIトークン」「gift_card_config_code」「giftee_box_config_code」が外部へ流出した場合、不正に発行されたギフトについてもすべて請求対象となりますので、API情報のお取り扱いにはご注意ください。
  • 固定IPをお持ちでない場合は、弊社担当までご連絡ください。

6. 「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」をコピーして取得してください。

※発行開始日以降にリクエストされた分についてはすべて請求対象となります。

config_code.png

 

ギフトの発行が完了し、キャンペーンが完了しましたらギフトの発行実績をご確認いただくことが可能です。

API利用のキャンペーン完了後の流れ

 

補足:「APIテスト案件」を使ったテスト方法

アカウント登録完了後、「APIテスト案件」という項目が表示されます。
「テスト案件を作成」ボタンをクリックすると、右側にテスト用の案件が自動生成されます。


検証用環境のご用意はありませんので、このテスト案件ページから「APIトークン」、「gift_card_config_code(giftee_box_config_code)」の取得とIP設定をしていただき、疎通テストを進めてください。審査の工程は不要です。

テスト実施の際に不具合がございましたら、弊社担当までご連絡ください。

※実際のキャンペーンを開始されるときには、APIテスト案件で使用したテスト用ではなく、正しい「APIトークン」と「gift_card_config_code」「giftee_box_config_code」をお使いください。

※IPアドレスも、実際のお申し込み案件に対して正しいものをご設定ください。

 

test.png

 

他にご質問がございましたら、リクエストを送信してください