How do I set up the IEX Portal REST API?

Generating an API KEY:

Setting up the REST API is very easy!

First, you have to get your API credentials.

1. Go to your IEX Portal.

2. Click on "Integration Options" on the dashboard.

3. In the API Key section, you can copy the existing API Key or generate a new key.

REST API setup details: 

1. URL: https://us-central1-bluebird-prod-fc31a.cloudfunctions.net/CreateEngagementWebhook

2. Call and response are in JSON

3. Authentication: use the headers "x-api-key" and "x-user-email". The API key is the one we just got and use the email associated to that key. 

   1. Each user has a different key.

4. URL Parameters (all required): 

   • "sender_email" (string)

     • It can be yours, or you can send it on someone else's behalf if you're an Organization Admin user

   • "receiver_email" (string)

   • "receiver_first_name" (string)

   • "receiver_last_name" (string)

   • "campaign_ids" (string[])

     • An array of campaign IDs

Even if it's just one, pass in an array of one. You can see a campaign ID by:

1. Going to the IEX Portal.
2. Click on "Assets Manager".
3. Click on "Campaigns".
4. Click on a campaign and then on the Edit campaign button.
5. The ID will be in the URL.

If the call is successful, we will return a 201 with the following JSON values:

• "order_id"

• "delayed_shipping_url": 

  • If it's a physical campaign, we will return the URL so the user to input their address and pick a gift (if needed).

• "digital_gift_urls":

  • If it's a digital gift, then it will be the redemption link.