Skip to main content

Environments and Access

How to get access to Propeller's APIs and what environments are available. By the end of this page you will know which credentials you need and how authentication works for both APIs.

API endpoints​

APIEndpoint
GraphQL v2https://api.helice.cloud/v2/graphql
REST v2https://api.helice.cloud/v2/{resource}

Authentication​

Both APIs require authentication, but they use different mechanisms.

GraphQL API​

GraphQL requests are authenticated using an API key sent as a header:

apiKey: YOUR_API_KEY

For frontend applications that need user-specific data (pricing, order history, account features), you also need a user session token obtained through the login mutation.

REST API​

The REST API uses OAuth 2.0 client credentials. You authenticate by sending your Client ID and Client Secret to the token endpoint, which returns a time-limited access token:

curl -X POST https://api.helice.cloud/oauth2/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"

The returned access_token is valid for 30 minutes and must be included as a Bearer token in subsequent requests.

Getting your credentials​

Initial API credentials are provided by Propeller when your partner account is set up. You will receive:

  • For GraphQL: an API key
  • For REST: a Client ID and Client Secret

The WordPress plugin requires two separate GraphQL API keys: one for general storefront operations and one for order processing. See General settings for details.

Once your tenant is set up, you can also create additional API keys for both GraphQL and REST with specific roles and permissions, either through the Backoffice UI or via GraphQL mutations.

Contact your Propeller account manager if you do not have credentials yet.

You are ready to start building​

You now have the platform mental model, understand which API to use for what and know how authentication works. Choose your next step:

  • WordPress Plugin: see Propeller in action with a pre-built B2B portal (fastest way to explore the platform)
  • Build a Frontend: build a custom frontend using the Storefront SDK or your own framework
  • Build an Integration: connect business systems using the REST API