Skip to main content

Authenticate

Connect to Propeller's GraphQL API and verify your credentials work.

Prerequisites​

API connection details​

All requests go to a single endpoint using the apiKey header for authentication.

SettingValue
Endpointhttps://api.helice.cloud/v2/graphql
MethodPOST
HeaderapiKey: YOUR_API_KEY

Verify your API key​

Send a simple query to confirm the connection works. Replace YOUR_API_KEY with your actual key.

curl -X POST https://api.helice.cloud/v2/graphql \
  -H "Content-Type: application/json" \
  -H "apiKey: YOUR_API_KEY" \
  -d '{"query": "{ channels { id name } }"}'

Expected result:

{
  "data": {
    "channels": [
      {
        "id": 1,
        "name": "B2B Portal"
      }
    ]
  }
}

If you see channel data, your API key is working.

Set up a GraphQL client​

Curl works for a quick credential check, but for exploring the API you want a GraphQL client. A client gives you autocomplete on fields, inline schema documentation and formatted responses.

Options:

  • GraphQL Explorer built into these docs (no setup required)
  • Altair (lightweight, available as browser extension or desktop app)
  • Postman (if you already use it for REST, it supports GraphQL too)

Configure your client with the endpoint and header from the table above, then run the same channels query:

query GetChannels {
  channels {
    id
    name
  }
}

You should see the same channel data as the curl response.

Next steps​

Your credentials work and you have a GraphQL client ready. Continue to the next page to start building a catalog.