Skip to main content

Testing Connectivity

API People provides the Hello API People API, a simple test endpoint you can use to validate your configuration and environment setup before interacting with development, test, or production endpoints.

With this API you can test the following:

  • Access Token: Ensure that your OAuth 2.0 token is correctly generated and included in the Authorization header.
  • mTLS Certificate: Verify that your mutual TLS (mTLS) setup is working correctly and that API People trusts your client certificate.
  • Required Headers: Confirm the presence and format of required headers such as x-correlation-id and Content-Type: application/json.

To learn how to use the endpoint and perform a test, see the section below.

Perform Test​

To test the connection using Hello API People API, you need to send a GET request to the /v1/hello-api-people endpoint, as in the example code below.

GET /v1/hello-api-people
Host: api.api-people.com
Authorization: Bearer <YOUR_ACCESS_TOKEN>
x-correlation-id: 123e4567-e89b-12d3-a456-426614174000

The response will confirm whether your request passed authentication and transport‑layer validation.

Error Response

If any part of your setup is misconfigured, the API returns an appropriate HTTP status code and error message. See HTTP Response Codes for more details about each status code.