1. Browse API Products
View the selection of API products we have to offer on the Products page.
Click on the Overview button for each API product to gain a more in-depth understanding of the products.
The API products have the following statuses:
- Get Now - the product is available to be used in your application.
- Coming Soon - the product is in the final stages of development. Receive a notification when
- it is live by submitting your email address on the product’s overview page.
2. Create an Account
To begin testing the API products, you must create an account on API Pulse.
- 1. Select the Register button on the top of the screen
- 2. Fill in and submit your details
- 3. You will receive an email asking you to validate your email address
- 4. Click the “Validate my email” button to confirm your registration and log back into the website.
3. Add an App
Once logged into your account, navigate to the My Apps page to add a sandbox app.
Scroll down to Sandbox Apps and click the “Add a New App” button.
Create an app name and select the API products you would like to test.
You will now see your new sandbox app, where you can find the sandbox key and secret key by expanding the app view.
4. Test in Sandbox
Now that you have your sandbox app with the sandbox key and secret key, navigate to the Documentation page
by clicking the “Test APIs” link in your sandbox app. Alternatively, navigate to the Products page
and click the “Documentation” button for the relevant API Product.
You can test the APIs using our online Sandbox environment or through Postman.
To test in the online Sandbox environment complete the following steps:
- 1. Click the “Authorize” button
- 2. Copy and paste your key and secret key into the relevant fields and click “Authorize”
- 3. Expand the method you would like to test
- 4. Click the “Try It Out” button
- 5. You have the option to edit the request body. Then click the “Execute” button
To test in Postman complete the following steps:
- 1. Click the “View Postman Guide” button at the top of the Documentation page
- 2. Follow the directions provided on the page
5. Go Live
When you want to use the APIs in your application, navigate to the My Apps page.
Find the sandbox app that has the API product you want to use and click “Go Live.”
Select the API product and individual APIs you want to go live with and click the “Go Live” button.
Complete the application process and once your application has been approved, you will find your live app under Production Apps on the My Apps page.
6. Give Feedback
We would like to work closely with our clients to ensure that our products are continually improving and meeting the needs of our clients.
If you have suggestions for future API products or have any queries regarding the current API Products, log a ticket by navigating to the Log A Ticket page under Support.
