Technical Documentation Portal

API references, integration guides, and support resources for partners

API Documentation

Complete reference for all public APIs. Use these endpoints to integrate your systems with AI-Act.Click.

🔑 Authentication

All API endpoints (except auth) require a Bearer token in the Authorization header.
Authorization: Bearer YOUR_JWT_TOKEN

Rate Limits

Default rate limits are specified per endpoint. Contact support for higher limits.

Authentication

Endpoints for user authentication and authorization

POST/api/auth/login

User Login

Authenticate a user and receive JWT tokens for API access.

Auth: NoneRate Limit: 10 requests per minute

Request Body

Content-Type: application/json

{
  "email": "partner@example.com",
  "password": "securepassword"
}

Responses

200Login successful
401Invalid credentials
429Rate limit exceeded
POST/api/auth/refresh

Refresh Token

Refresh an expired JWT token using a refresh token.

Auth: NoneRate Limit: 20 requests per minute

Request Body

Content-Type: application/json

Responses

200Token refreshed successfully
401Invalid or expired refresh token

Leads

Endpoints for lead management and retrieval

GET/api/partners/leads

List Leads

Retrieve a paginated list of leads assigned to your organization.

Auth: Bearer Token (JWT)Rate Limit: 100 requests per minute

Responses

200Success
GET/api/partners/leads/{id}

Get Lead Details

Retrieve detailed information about a specific lead.

Auth: Bearer Token (JWT)Rate Limit: 100 requests per minute

Responses

200Lead details retrieved successfully
404Lead not found
PATCH/api/partners/leads/{id}/status

Update Lead Status

Update the status of a lead (contacted, qualified, converted, etc.).

Auth: Bearer Token (JWT)Rate Limit: 50 requests per minute

Request Body

Content-Type: application/json

Responses

200Lead status updated successfully
400Invalid status value
404Lead not found

Analytics

Endpoints for retrieving analytics and reporting data

GET/api/partners/analytics/overview

Get Analytics Overview

Retrieve high-level analytics including lead counts, conversion rates, and revenue metrics.

Auth: Bearer Token (JWT)Rate Limit: 30 requests per minute

Responses

200Success
GET/api/partners/analytics/conversion-funnel

Get Conversion Funnel

Retrieve conversion funnel data showing lead progression through stages.

Auth: Bearer Token (JWT)Rate Limit: 30 requests per minute

Responses

200Funnel data retrieved successfully

Commissions

Endpoints for commission tracking and management

GET/api/partners/commissions

List Commissions

Retrieve a list of all commissions with filtering options.

Auth: Bearer Token (JWT)Rate Limit: 50 requests per minute

Responses

200Commissions retrieved successfully
GET/api/partners/commissions/{id}

Get Commission Details

Retrieve detailed information about a specific commission.

Auth: Bearer Token (JWT)Rate Limit: 50 requests per minute

Responses

200Commission details retrieved successfully
404Commission not found