Skip to main content

Authenticate

You need client credentials from the Backoffice to authenticate with the REST API. In this page you request an access token and use it to make your first API call.

Prerequisites​

  • A Propeller REST API credentials (client_id and client_secret) (from your account manager, see Environments and Access)

Step 1: Request an access token​

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

Replace your_client_id and your_client_secret with the credentials from your Backoffice.

Expected response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwic2NvcGUiOiJwcm9maWxlIiwiaWF0IjoxNzE2MjM5MDIyLCJleHAiOjE3MTYyNDA4MjJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "expires_in": 1800,
  "token_type": "Bearer",
  "scope": "profile"
}

The token is valid for 30 minutes.

Step 2: Make an authenticated request​

Use the token to fetch a product by SKU from the REST API:

curl -X GET https://api.helice.cloud/v2/products/sku/QSFP-40G-SR4 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Replace YOUR_ACCESS_TOKEN with the access_token value from step 1. Replace QSFP-40G-SR4 with a SKU that exists in your environment.

Expected response:

{
  "data": {
    "id": 6,
    "sku": "QSFP-40G-SR4",
    "names": [
      { "language": "NL", "value": "QSFP-40G-SR4 Transceiver Module" }
    ],
    "status": "A",
    "manufacturer": "Cisco",
    "supplier": "Intern",
    "taxCode": "H",
    "taxPercentage": 21,
    "minimumQuantity": 1,
    "unit": 1
  },
  "messages": [],
  "total": 1
}

If you see product data, authentication is working. You are ready to start building your integration.

Next steps​