> For the complete documentation index, see [llms.txt](https://support.ordereazi.com/central/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.ordereazi.com/central/developers/getting-started-with-the-api.md).

# Getting started with the API

What you can build with the OrderEazi API, where it lives, and how to make your first call.

Your online shop, marketplace, or own system can send orders to OrderEazi and read its products and stock through the OrderEazi API. It's a REST API that takes and returns JSON. Each OrderEazi organisation has its own API, at its own address, with its own keys.

### What you can build

* **Orders from a sales channel:** Send orders from an online shop or marketplace (a sales channel) into OrderEazi as projects (OrderEazi's record of an order, with its lines and documents).
* **Product and stock sync:** Read products, prices, and stock levels into a shop or another system, or update them from yours.
* **Client and supplier sync:** Keep clients, End Users (whoever actually receives a client's goods, such as a branch, a site, or the client's own customer), and suppliers in step with your CRM or accounting system.
* **Projects and documents:** Read projects, their lines, and their documents, and record ERP IDs (the matching record numbers in another system).
* **Shipping updates:** Tell OrderEazi when an order ships, with its waybill.
* **Notifications:** Have OrderEazi call your system when something happens, with webhooks. See [Webhooks](/central/developers/webhooks.md).
* **Reporting:** Read your data into Power BI or another reporting tool. See [OData and Power BI](/central/developers/odata-and-power-bi.md).

### Before you start

You'll need the organisation's OrderEazi address. This is the address its users sign in at, such as `https://yourcompany.ordereazi.com`, and it's the base URL for every API call.

You'll also need an API key. Someone in the organisation with the **API Keys** permission creates one for your integration, with only the permissions it needs. See [Authentication](/central/developers/authentication.md).

### How to make your first call

`/api/ping` checks that your address and key work.

1. Put your key in the `X-OrderEazi-Key` header.
2. Put `2.0` in the `x-api-version` header.
3. Send a GET request to `https://yourcompany.ordereazi.com/api/ping`.

```bash
curl https://yourcompany.ordereazi.com/api/ping \
  -H "X-OrderEazi-Key: YOUR_API_KEY" \
  -H "x-api-version: 2.0"
```

When it works, you get a `200` response:

```json
{
  "Success": true,
  "Warnings": null,
  "Data": {
    "HealthStatus": "Active",
    "Version": "5.48.4.0"
  }
}
```

If you get a `401`, the key is missing or wrong. See [Authentication](/central/developers/authentication.md).

### How API addresses work

Every endpoint starts with `/api/`, such as `/api/client/list` or `/api/order/{channel}`, where `{channel}` is the sales channel's name in OrderEazi. There's no version in the address: you choose the version with the `x-api-version` header. See [API versions](/central/developers/api-versions.md).

### Related pages

* [Authentication](/central/developers/authentication.md): keys and their permissions
* [Finding your API reference](/central/developers/finding-your-api-reference.md): every endpoint, with its fields
* [Rate limits](/central/developers/rate-limits.md): how many calls you can make