# Welcome

## Welcome

Use PlusSuite API v3 to list services, place orders, and track order status.

### Base URL

All endpoints are under:

`https://plussuite.co/api`

API version is path-based:

`/v3`

Example full URL:

`https://plussuite.co/api/v3/services`

### Authentication

There are two keys.

* **Public API key** (safe for client apps)
  * `GET /v3/services`: send as header `public_key: ...`
  * `GET /v3/orders`: send as query param `api_key=...` (public key)
* **Secret API key** (server-side only)
  * `POST /v3/order`: send in JSON body as `api_key`

{% hint style="warning" %}
Do not expose your secret API key in frontend code.
{% endhint %}

### Headers

* Always send: `Accept: application/json`
* For JSON requests: `Content-Type: application/json`

### Responses and errors

* Many success responses include: `status: true`
* Many error responses include: `status: false` and a `message`
* Some errors return only a `message`

### Quickstart

{% stepper %}
{% step %}

### Fetch services

Pick a `service` id and confirm `minimum` / `maximum`.

Go to [Service](/plussuite-docs/service.md).
{% endstep %}

{% step %}

### Place an order

Submit `api_key`, `service`, `link`, and `quantity`.

Go to [Order](/plussuite-docs/order.md).
{% endstep %}

{% step %}

### Track orders

Fetch latest orders and read `status`, `remains`, and `charge`.

Go to [Orders](/plussuite-docs/orders.md).
{% endstep %}
{% endstepper %}

### Endpoints

<table data-view="cards"><thead><tr><th>Title</th><th data-card-target data-type="content-ref">Target</th></tr></thead><tbody><tr><td>Service</td><td><a href="/spaces/pr1l57FddJggNInC62e6/pages/CfOWkZWtQdUwHy3BESN3">/spaces/pr1l57FddJggNInC62e6/pages/CfOWkZWtQdUwHy3BESN3</a></td></tr><tr><td>Order</td><td><a href="/spaces/pr1l57FddJggNInC62e6/pages/hEHvZI2nSY5vXT3pMNeb">/spaces/pr1l57FddJggNInC62e6/pages/hEHvZI2nSY5vXT3pMNeb</a></td></tr><tr><td>Orders</td><td><a href="/spaces/pr1l57FddJggNInC62e6/pages/jSxoPzpyXRtI8sjoWj4K">/spaces/pr1l57FddJggNInC62e6/pages/jSxoPzpyXRtI8sjoWj4K</a></td></tr></tbody></table>

### Summary

* `GET /v3/services`
  * Auth: `public_key` header
  * Returns: `services[]`
* `POST /v3/order`
  * Auth: JSON body `api_key` (secret)
  * Returns: `order` (your `external_order_id`)
* `GET /v3/orders`
  * Auth: query `api_key` (public)
  * Returns: `orders[]`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://plussuite.gitbook.io/plussuite-docs/welcome.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.