API Documentation

Integrate SortNex ranking engine into your applications with our RESTful API.

Getting Started

Quick start guide and authentication

Use the examples below to authenticate and call the API from your app.

API Reference

Complete endpoint documentation

Browse API

SDKs & Libraries

Official client libraries

Swagger/OpenAPI exports are available from the interactive reference.

Quick Start

Authentication

All API requests require authentication using JWT tokens. Obtain your API key from the dashboard:

Authorization: Bearer YOUR_API_KEY

Base URL

/api/v1

Sample Request

curl -X GET "/api/v1/rankings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Core Endpoints

GET/api/v1/rankings

Retrieve ranked product lists

POST/api/v1/rankings

Create new ranking job

GET/api/v1/algorithms

List available algorithms

POST/api/v1/products

Upload product data

Interactive API Documentation

Explore the full API with interactive documentation powered by Swagger/OpenAPI: