# Quickstart

Source: https://developers.weerom.com/docs/quickstart

> Make a key, send your first request and read the answer.

## Make a key

An administrator of the shop opens the WeerOm admin and goes to **Settings**, **Features**, **Connections**. The shop must be on the Premium plan.

They give the key a name, such as "Billit", and pick what it may do:

| Pick | Kind | Starts with | For |
| --- | --- | --- | --- |
| Read | Read key | `wo_live_` | A server that reads, such as an invoicing sync. |
| Read and change | Write key | `wo_live_` | A server that also books, cancels and moves. |
| Take bookings from a web page | Public key | `wo_pub_` | A booking page in the browser. |

This quickstart reads payments, so it needs a read key. The admin shows the key once. Copy it then.

## Ask who the key belongs to

`GET /shop` is a good first call. It proves the key works and tells you the currency and time zone of everything else.

```bash tab="cURL"
curl https://api.weerom.com/v1/shop \
  -H "Authorization: Bearer $WEEROM_KEY"
```

```js tab="JavaScript"
const response = await fetch("https://api.weerom.com/v1/shop", {
  headers: { Authorization: `Bearer ${process.env.WEEROM_KEY}` },
});
console.log(await response.json());
```

```php tab="PHP"
<?php
$curl = curl_init('https://api.weerom.com/v1/shop');
curl_setopt_array($curl, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('WEEROM_KEY')],
]);
print_r(json_decode(curl_exec($curl), true));
```

```python tab="Python"
import os
import requests

response = requests.get(
    "https://api.weerom.com/v1/shop",
    headers={"Authorization": f"Bearer {os.environ['WEEROM_KEY']}"},
)
print(response.json())
```

The answer:

```json
{
  "object": "shop",
  "name": "Studio Noord",
  "country": "BE",
  "currency": "EUR",
  "time_zone": "Europe/Brussels",
  "locale": "nl",
  "url": "https://studionoord.weerom.be"
}
```

## Read a list

Ask for the most recent payment:

```bash
curl "https://api.weerom.com/v1/payments?limit=1" \
  -H "Authorization: Bearer $WEEROM_KEY"
```

```json
{
  "object": "list",
  "data": [
    {
      "object": "payment",
      "id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90",
      "booking_id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90",
      "booking_code": "UEAMEFC9",
      "paid_at": "2026-11-21T10:12:40.000Z",
      "starts_at": "2026-11-21T09:30:00.000Z",
      "description": "Knippen en baard",
      "amount_cents": 4000,
      "list_price_cents": 4000,
      "discount_percent": 0,
      "net_cents": 3306,
      "vat_cents": 694,
      "vat_percent": 21,
      "tip_cents": 200,
      "currency": "EUR",
      "method": "bancontact",
      "service_id": "c2a41f6e-8d3b-4e97-b5a0-1f7c9e2d4a68",
      "staff_id": "8e1d5b7c-3a9f-4d20-b6c4-7a2e0f9d1c53",
      "customer": {
        "id": "5f0c9d3a-7b2e-4c61-8a4d-9e1f3b6c2d75",
        "name": "Lotte Peeters",
        "email": "lotte@example.com",
        "phone": "+32470123456"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "WzE3OTUyODcxMzA0MTIsIjBiNmYyYTRlLTVkMWMtNGY3YS05YTNlLTJjOGQxZTZmNGI5MCJd"
}
```

## Read the answer

- `amount_cents` is what the customer paid for the service, VAT included. `4000` is €40.
- `net_cents` and `vat_cents` split that amount. They always add up to `amount_cents`.
- `tip_cents` sits apart and is not part of `amount_cents`.
- `paid_at` is when staff noted the payment, in UTC. 10:12 UTC is 11:12 in Brussels in November.
- `has_more` is `true`, so another page follows. Send `next_cursor` back as `cursor` to get it. [Pagination](https://developers.weerom.com/docs/pagination) has a loop.

## Next

- [Authentication](https://developers.weerom.com/docs/authentication) covers the three kinds of key, keeping a key safe and what a 401 means.
- [Build a booking page](https://developers.weerom.com/docs/booking-page) shows free times and makes bookings with a public key.
- [Send payments to Billit](https://developers.weerom.com/docs/use-cases/billit) walks through an invoicing sync from start to end. The [use cases](https://developers.weerom.com/docs/use-cases) list nine more.
- [Webhooks](https://developers.weerom.com/docs/webhooks) tells your server about new bookings, changes and payments within seconds.
- The [API reference](https://developers.weerom.com/docs/reference) lists every endpoint, with a playground that takes your key.
