Skip to content
English
Sign in
Go to superfy.com
  • There are no suggestions because the search field is empty.

Access Superfy's API

This articles provides instructions on how to access and use Superfy's API

⚠️ Important: Authentication is currently handled at a different API endpoint due to our ongoing migration to a new system.

Step 1: Request Access

  • To use the Superfy API, you must have:

    • A valid login

    • Your unique Company ID

If you don’t have these yet, please contact our support team at support@superfy.com to request access.

Step 2: Authenticate

  • Use the following endpoint to authenticate and retrieve your access token:
     
    https://dashboard.superfy.com/api/users/authorize
  • You will receive a token back. You will be able to access the API with the token

 Example curl request:

curl --location --request POST 'https://dashboard.superfy.com/api/users/authorize' \
--header 'Content-Type: application/json' \
--data-raw '{
  "username": "[email_address goes here]",
  "password": "[password goes here]",
  "notificationCenterType": "android",
  "deviceID": 123
}'

Step 3: Access to API Documentation

The company id is required for some APIs

Note: uploading the documentation file to the Swagger link may result in limited interactivity within the API documentation. This is a temporary solution to provide access, and improvements are planned for future updates.

Step 4: API Endpoint

  • All authenticated API requests should be made to the following base URL:
https://eccwdj6oxd.execute-api.ap-southeast-2.amazonaws.com/production