 |
|
|
Mokugift API
Introduction
Mokugift API is a REST API for Mokugift Rewards customers to create, send and view rewards for their rewards campaigns.
The REST clients request the reward campaigns' unique IDs in order to access the API. For creating rewards, the clients would also need unique passcodes. Developers can get both campaign IDs and passcodes from the Developer Menu on the right of this page.
Developers should feel free to use the Mokugift Sandbox to test creating and view rewards without making real transaction nor creating/sending real rewards.
API version = 1.0
Mokugit Rewards functionality
The Mokugift API enables you to
- Send a reward to a customer
- Send multiple rewards to a given list of customers
- Query the list of rewards sent for the campaign in a given month
- Query the complete list of rewards ever sent for the campaign
Summary of Mokugift API
Please click on the Endpoint URL if you want to see the complete specification and samples of the call
Endpoint URL |
HTTP Method |
Passcode Requred |
Description |
Create & Send Reward
http://www.mokugift.jp/api/reward/<campaign_id> |
POST |
Yes |
creates a Reward for the specified campaign, sends the Reward via email to the recipient. |
Create Reward, No Send
http://www.mokugift.jp/api/reward_url/<campaign_id> |
POST |
Yes |
creates a Reward for the specified campaign, returns the URL to the Reward (no email will be sent to the recipient). |
Create Reward, No Send, No Email Address
http://www.mokugift.jp/api/reward_url2/<campaign_id> |
POST |
Yes |
creates a Reward for the specified campaign without passing in the recipient's email. It returns the URL to the Reward.
(You will be passing in an unique ID of the recipient that your system recognizes.) |
Create & Send Multiple Rewards
http://www.mokugift.jp/api/multi_rewards/<campaign_id>< |
POST |
Yes |
creates a Reward for each of the recipients provided for the specified campaign, sends the Reward via email to the recipients. |
Create Multiple Rewards, No Send
http://www.mokugift.jp/api/multi_reward_urls/<campaign_id> |
POST |
Yes |
creates a Reward for each of the recipients provided for the specified campaign, returns a list of URLs to the Rewards (no email will be sent to the recipients). |
Create Multiple Rewards, No Send, No Email Addresses
http://www.mokugift.jp/api/multi_reward_urls2/<campaign_id> |
POST |
Yes |
creates a Reward for each of the recipients provided for the specified campaign without passing in the recipient's emails. It returns a list of URLs to the Rewards while no email will be sent to the recipients.
(You will be passing in an unique ID of the recipient that your system recognizes.) |
Query Rewards for the Month
http://www.mokugift.jp/api/rewards_in_month/<campaign_id>/<month>/<year> |
GET |
No |
returns the list of all Rewards created for the specified campaign in the specified month. |
Query all Rewards
http://www.mokugift.jp/api/all_rewards/<campaign_id> |
GET |
No |
returns the list of all Rewards ever created for the specified campaign. |
Mokugift API Errors
Here is the complete list of potential errors in a Mokugift API response
|
