Test API Key

Overview

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

There are many options for API testing. For this scenario, Apollo is going to use this developer hub and Postman, but the same information can be applied to your preferred development platform.

Test Apollo API in Documentation

To test Apollo API directly in this documentation:

1. Go to the reference docs for an endpoint such as People API Search.
2. Choose one of the available programming languages.
3. Select Header from the credentials dropdown, then enter your API key in the x-api-key field.
4. Enter parameter details to generate your API request. At a minimum, address the required parameters. As you add values to the parameters, the API request updates live.
5. Click Try It! to send your request.

The response from Apollo API appears directly in the Response section of the docs. A successful request generates a response with a 200 status code.

Test Apollo API Using an API Client

To test the Apollo API in an API client like 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 receive the following JSON response:

{
  "healthy": true,
  "is_logged_in": true
}

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.

Use the Apollo API

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