Get Started

Acquiring an API Key

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can can access your API key directly from your management dashboard:

  1. Login to the management dashboard with your account

  2. Using the left side navigation panel click on Settings -> Account

  3. Here you can reveal your API key or easily copy it.

Important to know: Currently you can have only one API key. Make sure to save it in a secure location and do not share it. Also make sure to use it only on secured environments like your backend and absolutely not your front end.

Using Your API Key

You may use any server-side programming language that can make HTTPS requests to target the Giftoin API. All requests should target the URL:

You need to supply your API Key in REST API calls in the header with a custom header: x-gft_api_key

Make your first request

To make your first request, send an authenticated request to the campaigns endpoint. This will return you an array of existing campaigns, if you have none it will return an empty array.

Don't forget: You must include your API key with every API call, otherwise you will receive an error.

After creating your first campaign in the management dashboard, you can proceed to utilize other API calls. To begin sending gifts, please head over to Card/Coupon. For fetching campaign data, including gifts, to present in your application, please navigate to Campaigns.

Last updated