All Collections
API
API: Getting Started
API: Getting Started

How to start building and testing your API integration

Matthew avatar
Written by Matthew
Updated over a week ago

Register for a Sandbox Account

Go to testbed.giftbit.com and register for a free sandbox account.

Test Token

Log into your Testbed account and click on the Account menu then select API Keys. Generate a test token and include the token in the header of your API calls.

API Docs

Read the API documentation at www.giftbit.com/giftbitapi

The API docs explain the function of each of the endpoints and how to structure your requests.

Sandbox Differences

Although the sandbox closely simulates the use of the web app and the API, there are certain key differences between Testbed and Production:

  • You are provided with a generous fake balance for testing purposes. Testbed will simulate credit card purchases with Stripe test cards, but that is the extent of payment processing that is possible in the test environment.

  • Testbed rewards are not redeemable for gift cards, although brands like Amazon.com and Visa will let you click through to a representation of the gift card or prepaid card that would normally be shown in the redemption process.

  • All email-based rewards are sent to your inbox, not the intended contact for each reward. Testbed rewards are appropriately labeled, but just to be safe, we prevent test rewards from being sent to any outside parties.

  • The selection of rewards in Testbed is abbreviated because of the limited number of sandbox brands available from our suppliers. Preview the full selection of Production rewards at giftbit.com/rewards.

  • Processing times in Testbed may not match Production due to differences between environments.

Testing your Integration

How much you test your integration is up to you, but we recommend designing some error handling, so the fulfillment of your rewards isn’t impacted by an undeliverable contact or changes in the availability of a reward option.

Ready for Production

If you haven’t already registered for a production account, sign up at www.giftbit.com.

When you’re ready to go live, email testbed@giftbit.com

We’d love to see what you built, feel free to include screenshots in your request.

You’re nearly done! Once we enable API access in your production account you can complete the last few setup steps:

  • Generate a Production token to include in your API requests

  • Recreate any reward templates you used in Testbed

  • Call the /brands endpoint in Production to pull images, descriptions, and denominations for our full selection of rewards

Did this answer your question?