Skip to content

Quick Start

Integrate with the FluxiQ NPC API in 5 minutes.

1. Get your API Key

To access the API, you need an API Key. Contact support to obtain your credentials:

2. Environments

EnvironmentBase URLDescription
Localhttp://localhost:4000/api/v1/centralLocal development
Sandboxhttps://sandbox.pixconnect.com.br/api/v1/centralTesting and staging
Productionhttps://api.pixconnect.com.br/api/v1/centralProduction environment

3. First Request

Let's verify that your API Key is working correctly by making a request to the health check endpoint.

bash
curl -X GET "https://sandbox.pixconnect.com.br/api/v1/central/health" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json"
javascript
const response = await fetch(
  "https://sandbox.pixconnect.com.br/api/v1/central/health",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your_api_key_here",
      "Content-Type": "application/json",
    },
  }
);

const data = await response.json();
console.log(data);
python
import requests

url = "https://sandbox.pixconnect.com.br/api/v1/central/health"
headers = {
    "X-API-Key": "your_api_key_here",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

4. Expected Response

If everything is configured correctly, you will receive the following response:

json
{
  "status": "ok",
  "timestamp": "2026-02-03T12:00:00Z",
  "version": "1.0.0"
}

Response Codes

CodeMeaning
200Success - API functioning normally
401Unauthorized - Invalid or missing API Key
429Request limit exceeded
500Internal server error

Next Steps

Now that your integration is working, explore the API resources:

Documentação da API FluxiQ NPC