Health Check Endpoint

The health check endpoint allows you to verify that the API is functioning correctly and test your API key authentication.

Production URL: https://api.fluenceinsights.com

Endpoint

GET /saude

Authentication

Authentication is optional for this endpoint, but recommended to test your API key:

X-API-Key: your-api-key-here

Example Requests

With API Key (Recommended)

curl "https://a7qq5h74ej.execute-api.us-west-2.amazonaws.com/production/saude" \
  -H "X-API-Key: your-api-key-here"

Response Format

Actual Response (With API Key)

{
  "status": "saudável",
  "message": "🎉 API CRM Português com Sistema de Créditos FUNCIONANDO!",
  "timestamp": "2024-07-18T14:00:00Z",
  "version": "1.3.0",
  "sistema_creditos": "✅ Sistema de créditos ativo",
  "features": [
    "credit_tracking",
    "api_key_validation", 
    "billing_transparency",
    "region_br_support"
  ]
}

Error Response (Invalid API Key)

{
  "message": "Forbidden"
}

Response Fields

Field	Type	Description
status	string	API health status ("healthy" or "unhealthy")
timestamp	string	Current server timestamp in ISO 8601 format
version	string	Current API version
region	string	AWS region where the API is deployed

Use Cases

1. API Key Testing: Verify your API key is valid and working
2. Health Monitoring: Check if the API is operational
3. Integration Testing: Validate your connection to the API
4. Uptime Monitoring: Monitor API availability

Status Codes

Code	Description
200	API is healthy and operational
403	Invalid API key (when provided)
500	Internal server error

Example Usage

JavaScript/Fetch

const response = await fetch('https://6g0pxvn3va.execute-api.us-west-2.amazonaws.com/dev/saude', {
  headers: {
    'X-API-Key': 'your-api-key-here'
  }
});
const health = await response.json();
console.log('API Status:', health.status);

Python

import requests

response = requests.get(
    'https://6g0pxvn3va.execute-api.us-west-2.amazonaws.com/dev/saude',
    headers={'X-API-Key': 'your-api-key-here'}
)
health = response.json()
print(f"API Status: {health['status']}")

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://6g0pxvn3va.execute-api.us-west-2.amazonaws.com/dev/saude',
  {
    headers: {
      'X-API-Key': 'your-api-key-here'
    }
  }
);
console.log('API Status:', response.data.status);

---

For support, contact: support@tryfluence.tech