API Endpoints Documentation

Complete reference for all API endpoints with detailed examples across multiple programming languages.

Authentication

All API requests require authentication using your admin API key.

Base URL

https://domain.com/admin/v1

Request Format Options

Authentication Examples

curl --location 'https://domain.com/admin/v1' \
--form 'action="getOrders"' \
--form 'key="YOUR_API_KEY"'
POST/admin/v1/

Get Single Order (getOrder)

Retrieves a single pending order from the system. The order status automatically changes to Processing after successful retrieval.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "getOrder"Yes
typeintegerService ID to filter ordersYes

Get Order Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="getOrder"' \
--form 'key="YOUR_API_KEY"' \
--form 'type="SERVICE_ID"'

Response

{
    "status": "success",
    "message": "Order fetched successfully",
    "id": "15",
    "link": "https://www.tiktok.com/@user",
    "charge": "0.10029597233",
    "user_id": "1a6803ab-d7ca-4b55-93da-ac150fd27108",
    "quantity": "100",
    "comments": ""
}

POST/admin/v1/

Get Multiple Orders (getOrders)

Retrieves up to 100 pending orders. Orders change to Processing status after successful retrieval.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "getOrders"Yes
typeintegerService ID to filter ordersYes

Get Orders Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="getOrders"' \
--form 'key="YOUR_API_KEY"' \
--form 'type="SERVICE_ID"'

Response

{
    "status": "success",
    "message": "Orders fetched successfully",
    "orders": [
        {
            "id": "15",
            "link": "https://www.tiktok.com/@user",
            "charge": "0.10029597233",
            "user_id": "1a6803ab-d7ca-4b55-93da-ac150fd27108",
            "quantity": "100",
            "comments": ""
        },
        {
            "id": "16",
            "link": "https://www.tiktok.com/@kuser2",
            "charge": "0.10029597233",
            "user_id": "1a6803ab-d7ca-4b55-93da-ac150fd27108",
            "quantity": "100",
            "comments": ""
        }
    ]
}

POST/admin/v1/

Update Multiple Orders (updateOrders)

Update the status and details of multiple orders simultaneously.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "updateOrders"Yes
ordersarrayArray of order updatesYes

Update Orders Example

curl --location 'https://domain.com/admin/v1' \
--header 'Content-Type: application/json' \
--data '{
  "key": "YOUR_API_KEY",
  "action": "updateOrders",
  "orders": [
    {
      "id": "1",
      "status": "IN_PROGRESS"
    },
    {
      "id": "2",
      "status": "PROCESSING",
      "start_count": "22"
    },
    {
      "id": "3",
      "status": "PARTIAL",
      "remains": "10"
    },
    {
      "id": "4",
      "status": "COMPLETED"
    },
    {
      "id": "5",
      "start_count": "32"
    },
    {
      "id": "6",
      "remains": "76"
    }
  ]
}'

Response

{
  "status": "success",
  "message": "Orders updated successfully",
  "orders": {
    "1": {
      "status": "success"
    },
    "2": {
      "status": "success"
    }
  }
}

POST/admin/v1/

Set Order In Progress (setInprogress)

Update order status to "In Progress" with optional start count.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setInprogress"Yes
idstringOrder IDYes
start_countintegerStarting countNo

Set In Progress Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setInprogress"' \
--form 'key="YOUR_API_KEY"' \
--form 'id="ORDER_ID"' \
--form 'start_count="100"'

Response

{
   "status": "success",
   "message": "Order set in progress successfully"
}

POST/admin/v1/

Set Order Processing (setProcessing)

Update order status to "Processing".

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setProcessing"Yes
idstringOrder IDYes

Set Processing Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setProcessing"' \
--form 'key="YOUR_API_KEY"' \
--form 'id="ORDER_ID"'

Response

{
   "status": "success",
   "message": "Order set processing successfully"
}

POST/admin/v1/

Set Start Count (setStartcount)

Set the starting count for an order.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setStartcount"Yes
idstringOrder IDYes
start_countintegerStarting countYes

Set Start Count Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setStartcount"' \
--form 'key="YOUR_API_KEY"' \
--form 'id="ORDER_ID"' \
--form 'start_count="100"'

Response

{
   "status": "success",
   "message": "Order set started successfully"
}

POST/admin/v1/

Cancel Order (setCanceled)

Cancel an order and process refund.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setCanceled"Yes
idstringOrder IDYes

Cancel Order Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setCanceled"' \
--form 'key="YOUR_API_KEY"' \
--form 'id="ORDER_ID"'

Response

{
   "status": "success",
   "message": "Order set refunded successfully"
}

POST/admin/v1/

Set Partial Completion (setPartial)

Mark order as partially completed and process refund for remaining quantity.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setPartial"Yes
idstringOrder IDYes
remainsintegerRemaining quantityYes

Set Partial Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setPartial"' \
--form 'key="YOUR_API_KEY"' \
--form 'id="ORDER_ID"' \
--form 'remains="50"'

Response

{
   "status": "success",
    "message": "Order set partial successfully"
}

POST/admin/v1/

Mark Order Complete (setCompleted)

Mark an order as completed.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setCompleted"Yes
idstringOrder IDYes

Complete Order Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setCompleted"' \
--form 'key="YOUR_API_KEY"' \
--form 'id="ORDER_ID"'

Response

{
   "status": "success",
   "message": "Order set completed successfully"
}

POST/admin/v1/

Update Remaining Count (setRemains)

Update the remaining count for an order.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setRemains"Yes
idstringOrder IDYes
remainsintegerRemaining quantityYes

Set Remains Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setRemains"' \
--form 'key="YOUR_API_KEY"' \
--form 'id="ORDER_ID"' \
--form 'remains="25"'

Response

{
   "status": "success",
   "message": "Order set remains successfully"
}

POST/admin/v1/

Get Refills Task (getRefills)

Retrieve a pending refills task. After successful request, the status is updated to ‘PENDING’

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "getRefills"Yes
service_idintegerService IDNo

Get Refill Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="getRefills"' \
--form 'key="YOUR_API_KEY"' \
--form 'service_id="SERVICE_ID"'

Response

{
    "status": "success",
    "message": "Refills fetched successfully",
    "refills": [
        {
            "id": "1",
            "order_id": "24",
            "service_id": "3412",
            "link": "https://aa.com",
            "start_count": "0",
            "quantity": "10",
            "date": "2024-12-04T18:01:57.608Z"
        }
    ]
}

❌ Get Cancel Task (getCancel)

Retrieve a pending cancel task.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "getCancel"Yes
service_idintegerService IDNo

Get Cancel Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="getCancel"' \
--form 'key="YOUR_API_KEY"' \
--form 'service_id="SERVICE_ID"'

Response

{
   "status": "success",
   "cancel": "241",
   "order_id": "7635",
   "service_id": "1",
   "link": "https://x.com/fast"
}

POST/admin/v1/

Complete Refill (setRefillCompleted)

Mark a refill task as completed.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setRefillCompleted"Yes
refillstringRefill task IDYes

Complete Refill Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setRefillCompleted"' \
--form 'key="YOUR_API_KEY"' \
--form 'refill="REFILL_ID"'

Response

{
    "status": "success",
    "message": "Refill has been set to completed successfully",
    "refill": 1
}

POST/admin/v1/

Reject Refill (setRefillRejected)

Mark a refill task as rejected.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setRefillRejected"Yes
refillstringRefill task IDYes

Reject Refill Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setRefillRejected"' \
--form 'key="YOUR_API_KEY"' \
--form 'refill="REFILL_ID"'

Response

{
    "status": "success",
    "message": "Refill has been set to rejected successfully",
    "refill": 1
}

POST/admin/v1/

Start Refill (setRefillInprogress)

Mark a refill task as in progress.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setRefillInprogress"Yes
refillstringRefill task IDYes

Start Refill Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setRefillInprogress"' \
--form 'key="YOUR_API_KEY"' \
--form 'refill="REFILL_ID"'

Response

{
    "status": "success",
    "message": "Refill has been set to in progress successfully",
    "refill": 1
}

❌ Reject Cancel Request (setCancelRejected)

Reject a cancel request for an order.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "setCancelRejected"Yes
cancelstringCancel task IDYes

Reject Cancel Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="setCancelRejected"' \
--form 'key="YOUR_API_KEY"' \
--form 'cancel="CANCEL_ID"'

Response

{
    "status": "success",
    "message": "Refill has been cancelled successfully",
    "refill": 1
}

POST/admin/v1/

Add Payment (addPayment)

Add a payment to a user's account.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "addPayment"Yes
userstringUser mail / User IDYes
amountstringPayment amountYes
detailsstringPayment detailsYes
affiliate_commissionintegerAffiliate commission flag (1 or 0)No

Add Payment Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="addPayment"' \
--form 'key="YOUR_API_KEY"' \
--form 'user="user_adress@mail.com"' \
--form 'amount="100.00"' \
--form 'details="Payment for services"' \
--form 'affiliate_commission="0"'

Response

{
    "status": "success",
    "message": "Payment has been added successfully",
    "payment": 1
}

POST/admin/v1/

Add Ticket (addTicket)

Create a new support ticket.

Parameters

ParameterTypeDescriptionRequired
keystringYour Admin API keyYes
actionstringMust be "addTicket"Yes
userstringUser mail / User IDYes
subjectstringTicket subjectYes
messagestringTicket messageYes

Add Ticket Example

curl --location 'https://domain.com/admin/v1' \
--form 'action="addTicket"' \
--form 'key="YOUR_API_KEY"' \
--form 'user="user_adress@mail.com"' \
--form 'subject="Support Request"' \
--form 'message="I need assistance with my order."'

Response

{
    "status": "success",
    "message": "Ticket has been created successfully",
    "ticket": 1
}

Error Responses

All endpoints may return error responses in the following format:

{
    "status": "fail",
    "error": "error_code",
    "message": "Key is required",
    "missing": [
        "key"
    ]
}

Best Practices

  1. Error Handling

    • Always check response status
    • Implement proper error handling
    • Log failed requests for debugging
  2. Rate Limiting

    • Implement exponential backoff
    • Keep request rates reasonable
    • Handle rate limit responses
  3. Security

    • Store API keys securely
    • Use HTTPS for all requests
    • Monitor API usage

Was this page helpful?