Skip to main content

​
Quickstart: Verify Your Setup

The best way to confirm your API key is working correctly is to make a simple request to our health endpoint. This endpoint requires authentication but doesn’t modify any data, making it the perfect first call.

​
Prerequisites

  • You must have your unique API key from the Onboarding process.

​
1. The Endpoint

We will be making a GET request to the following URL: https://www.venturu.com/api/partner/v1/health

​
2. Making the Request

Use your preferred HTTP client or tool, like cURL, to make the request. Remember to replace YOUR_API_KEY with the secret token provided to you. 
curl -X GET "https://www.venturu.com/api/partner/v1/health" \
     -H "Authorization: Bearer YOUR_API_KEY"

​
3. The Successful Response

If your API key is valid, you will receive a 200 OK status code and a JSON response body similar to this:
Response: 200 OK
{
  "status": "success",
  "timestamp": "2023-10-26T10:00:00.000Z"
}
Congratulations! You have successfully connected to the Venturu API.

​
Next Steps

Now that your connection is verified, it’s a good time to understand some Core Concepts of our API before diving into the guides.