Using Postman to check API calls

• Setting up
• Using Postman
• Set up a test ping
• Set up headers
• Creating a new user
• Checking your new user data

Setting up

1. Get Postman.
2. Review the developer documentation for API calls.
3. Make sure you have a unique API key for your needs. The API keys given for sftp access, Shopify extensions, and Magento extensions will not authenticate for user creation, transactional emails, events, or other data transfer.

If you have any questions contact tech support.

Using Postman

1. Click New.
2. Click Request.
   
   
   
   
3. Select a folder and click Save.
   
   
   
   

Set up a test ping

1. Copy the Ping URL from the documentation into Postman.
   
   
   
   
2. Set the request type to GET.
   
   
   
   

Set up headers

1. Click Headers and select or create a new key.
   
   
   
   
2. Create a key for both the Content-Type and Authorization headers and assign the corresponding value:
   
   
   
   
3. Send your ping. If your call was structured correctly, this should return your site ID.  If not you will see an error.

Creating a new user

1. Copy the users URL into Postman.
   
   
   
   
2. Switch the call to POST.
   
   
   
   
3. Update the header to include "Content-Type Application/json."
   
   
   
   
4. Copy the example body and paste it in the Body tab.
   
   
   
   
5. Click Body, select "raw," and modify the body to create a new and unique example.
   
   
   
   
6. Send your Post call.

Checking your new user data

1. Delete the body from your POST call.
2. Change the call type from POST to GET.
   
   
   
   
3. Update the URL to https://data.retentionscience.com/v3/users/email/example@example.com.
4. Update the URL and replace example@example.com with your user email.
5. Send your request.