API Documentation
Introduction
Superlink provides a REST API to interact with our backend for our various products.
Prerequisites
Before you begin, ensure you have:
- Completed the Superlink Partner Onboarding: You must be a Superlink partner to use our SDK. If you aren’t onboarded yet, please reach out to us.
- Received an API Key: You must have an API key to authenticate your requests. You will receive an API key when you onboard as a partner.
Explore our API endpoints
Authentication
API endpoints are authenticated using Bearer tokens. Reach out to us to become a partner and receive your API key.
You can pass the token in the Authorization
header of the request, and remember to prefix the token with Bearer
and a space.
OpenAPI Specification
Superlink provides an OpenAPI specification file for our API. You can use this file to generate client libraries, documentation, and more.
Superlink API Specification
View the OpenAPI specification file
Client SDK
Superlink also provides an SDK to interact with our API. The SDK is available in Javascript, Go and Python.