Test API Key

Overview

You've already created an API key. Now you're ready to test the Apollo API and confirm access.

There are many options for API testing. For this article, Apollo is going to use Postman, but the same information can be applied to your preferred testing methods.

Test the Apollo API Using Postman

To test the API using Postman:

1. Create a new request in Postman. Select the GET method, then copy and paste https://api.apollo.io/v1/auth/health in the URL field.

2. Click the Authorization tab, then select No Auth from the Auth Type drop-down.

3. Click the Headers tab, then add the following keys and values:

4. Click Send. This sends a request to the Apollo server to log into the API.

If your setup is correct, you will receive the following JSON response:

If both values in the response are true, you are ready to use the API.

❗️

False Response

If either object has a value of False, check your request details again. Delete any erroneous spaces or returns after your API key. Once you are sure your request is formatted appropriately, click Send to try again.

Test the Apollo API in Documentation

You can also test the API directly in this documentation. To do so:

1. Go to the documentation for an endpoint such as People Enrichment.
2. On the right column of the page, choose a programming language. Then, paste your API key in the Authorization Header field.
3. Click Try It! in the sample request.

The response populates below the sample request. A successful request generates a response with a 200 status code.

Use the Apollo API

You've confirmed that your API key is working with the API. Now hop into a couple of Apollo API use cases to try out its functionality.