API Documentation

Verify the connector version and supported operations.

curl -sS "https://panel.example.com/connector.php?action=health" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"

{
  "success": true,
  "data": {
    "version": "1.1",
    "capabilities": [
      "tickets.list", "tickets.get", "tickets.reply", "tickets.create",
      "orders.list", "orders.get", "users.list", "users.find",
      "orders.cancel_refund"
    ]
  }
}

• • data.version must be a non-empty string.
• • The original eight capabilities remain required.
• • orders.cancel_refund is optional. Advertise it only after implementing the documented atomic cancel-and-refund operation.

Return ticket IDs that should be checked for new customer messages.

curl -sS "https://panel.example.com/connector.php?action=tickets.list&offset=0&limit=100" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"

{
  "success": true,
  "data": {
    "list": [
      { "id": 4831 },
      { "id": 4829 }
    ],
    "pagination": {
      "offset": 0,
      "limit": 100,
      "total": 2,
      "has_more": false,
      "next_offset": null
    }
  }
}

• • Each id must be a stable positive integer.
• • Return recently updated open tickets first so new messages are discovered promptly.

Return one ticket and a page of its messages.

curl -sS "https://panel.example.com/connector.php?action=tickets.get&ticket_id=4831&offset=0&limit=100" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"

{
  "success": true,
  "data": {
    "id": 4831,
    "subject": "Order Support",
    "status": "pending",
    "user": {
      "id": 72,
      "username": "customer1"
    },
    "messages": [
      {
        "id": "msg-901",
        "message": "speedup 15020",
        "sender_name": "customer1",
        "is_staff": false,
        "created_timestamp": 1786452600
      }
    ],
    "pagination": {
      "offset": 0,
      "limit": 100,
      "total": 1,
      "has_more": false,
      "next_offset": null
    }
  }
}

• • subject is required because PANEL ASSIST applies its configured ticket-category rules to it.
• • Use status "closed" for a closed ticket. Closed tickets stop being polled after the closing state is observed.
• • Message IDs must remain stable. They only need to be unique inside their ticket.
• • is_staff must be true for staff replies and false for customer messages. Staff messages are never automated.
• • created_timestamp is a Unix timestamp in seconds. Messages are processed oldest first.

Add a staff reply to an existing ticket.

curl -sS -X POST "https://panel.example.com/connector.php?action=tickets.reply" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN" \
  --data '{"ticket_id":4831,"message":"Your request was received.","staff_name":"PANEL ASSIST Bot"}'

{
  "success": true,
  "data": {}
}

• • Create exactly one staff message for the supplied ticket.
• • PANEL ASSIST does not retry this POST automatically.

Create a ticket for an exact panel username.

curl -sS -X POST "https://panel.example.com/connector.php?action=tickets.create" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN" \
  --data '{"username":"customer1","subject":"Verification code","message":"Your code is 193204"}'

{
  "success": true,
  "data": {}
}

• • Create exactly one ticket for the exact username.
• • PANEL ASSIST does not retry this POST automatically.

Return a paginated order list for connection and schema checks.

curl -sS "https://panel.example.com/connector.php?action=orders.list&offset=0&limit=100" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"

{
  "success": true,
  "data": {
    "list": [{ "id": 15020, "status": "processing", "user": { "id": 72, "username": "customer1" } }],
    "pagination": { "offset": 0, "limit": 100, "total": 1, "has_more": false, "next_offset": null }
  }
}

Return the order fields used by ownership, status, mode, provider, refill, and cancellation checks.

curl -sS "https://panel.example.com/connector.php?action=orders.get&order_id=15020" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"

{
  "success": true,
  "data": {
    "id": 15020,
    "user": { "id": 72, "username": "customer1" },
    "status": "processing",
    "mode": "auto",
    "external_id": "PX-88219",
    "provider": { "url": "https://provider.example" },
    "service_name": "Instagram Followers | Refill 30 Days",
    "created_timestamp": 1783861200,
    "actions": {
      "refill": false,
      "cancel_and_refund": false
    },
    "refill_expired": false
  }
}

• • Supported status values used by automation are pending, processing, in_progress, completed, partial, canceled, cancelled, and refunded.
• • mode must be manual or auto when orders.cancel_refund is supported.
• • For a manual order, external_id may be null and provider may be "manual" or null.
• • For a provider order, external_id and provider.url are required so the configured provider destination can be resolved.
• • service_name and created_timestamp let the platform determine refill support and its validity period from the service name. Use a Unix timestamp in seconds.
• • When service_name is explicit, it takes precedence over actions.refill. Existing connectors that omit these fields continue using actions.refill and refill_expired as fallback.
• • Set actions.refill to true only when the service supports refill. Set refill_expired to true after the guarantee expires.
• • Set actions.cancel_and_refund to true only when this exact order can be canceled and its charge returned atomically.

Atomically cancel one eligible order and return its charge to the customer balance.

curl -sS -X POST "https://panel.example.com/connector.php?action=orders.cancel_refund"   -H "Accept: application/json"   -H "Content-Type: application/json"   -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"   --data '{"order_id":15020,"reason":"Canceled automatically at customer request"}'

{
  "success": true,
  "data": {
    "order_id": 15020,
    "status": "canceled",
    "refunded": true
  }
}

• • This capability is optional and does not affect connectors that implement only the original eight capabilities.
• • Reject the request unless a fresh lookup of the same order would return actions.cancel_and_refund: true.
• • The status update and balance refund must complete in one database transaction.
• • Use row locking or an equivalent atomic guard so repeated requests cannot refund the order twice.
• • Return success only after both cancellation and refund are committed. The platform sends this POST once and then re-reads orders.get to verify status=canceled.

Return a paginated user list for connection and schema checks.

curl -sS "https://panel.example.com/connector.php?action=users.list&offset=0&limit=100" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"

{
  "success": true,
  "data": {
    "list": [{ "id": 72, "username": "customer1" }],
    "pagination": { "offset": 0, "limit": 100, "total": 1, "has_more": false, "next_offset": null }
  }
}

Find one user by exact username for Telegram and WhatsApp account linking.

curl -sS "https://panel.example.com/connector.php?action=users.find&username=customer1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_CONNECTOR_TOKEN"

{
  "success": true,
  "data": {
    "user": { "id": 72, "username": "customer1" }
  }
}

• • When no user matches, return HTTP 200 with {"success":true,"data":{"user":null}}.