Vrátí seznam krátkých domén dostupných pro váš účet. Hodnoty z tohoto seznamu patří do parametru `url_type` při [zkracování odkazu](https://www.bulkgate.com/cs/dokumentace/zkracovac/zkracovac-zkraceni-url/).

## API URL

Adresa URL používaná k odeslání požadavků HTTP:

```url
https://portal.bulkgate.com/api/1.0/shortener/domains
```

> [!NOTE]
> Nedostane-li se požadavek k cíli, zopakujte ho na [záložním serveru](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/zalozni-server/) `backup1.bulkgate.com`.

## Podporované HTTP metody

- `POST` - `application/json`

```http
POST /api/1.0/shortener/domains HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

> [!NOTE]
> API má nastavenou kvótu na `20` požadavků za minutu.

## Tabulka s parametry

| NÁZEV PARAMETRU   | HODNOTA                                                                       | POVINNÝ | VÝCHOZÍ HODNOTA |
|:------------------|:-------------------------------------------------------------------------------|:--------|:----------------|
| application_id    | [Aplikační identifikátor](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/administrace-api/)                        | **Ano** | -               | 
| application_token | [Aplikační ověřovací token](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-tokeny/)	                             | **Ano** | -               |
| variant           | Tvar odpovědi - `list`, `key_value` nebo `label_value`, viz [Tvary odpovědi](#tvary-odpovedi) | Ne      | `list`          |

### Tvary odpovědi

Všechny tři varianty nesou tytéž domény, liší se jen strukturou - vyberte si tu, kterou rovnou spolkne váš formulář.

| HODNOTA       | TVAR `data`                                              |
|:--------------|:-----------------------------------------------------------|
| `list`        | Pole řetězců.                                              |
| `key_value`   | Objekt, kde klíč i hodnota je doména.                      |
| `label_value` | Pole objektů `{"label": …, "value": …}`.                   |

> [!NOTE]
> Seznam není pro všechny účty stejný. Obsahuje i vaše [vlastní domény](https://www.bulkgate.com/cs/centrum-napovedy/kampan/zkracovac-url/), pokud nějaké máte, a ty stojí na jeho začátku - první doména v seznamu je zároveň ta, kterou `shorten` použije, když `url_type` vynecháte.

## Příklad požadavku

```http-json
POST /api/1.0/shortener/domains HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json

{
  "application_id": 451,
  "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
  "variant": "list"
}
```

## Odpověď

**V případě úspěchu:**

```json
{
    "data": [
        "ur7.wf",
        "ms6.fr",
        "ur7.yt",
        "ur7.tf",
        "ms6.wf",
        "ms6.tf",
        "track-message.com"
    ]
}
```

Tentýž seznam ve variantě `key_value`:

```json
{
    "data": {
        "ur7.wf": "ur7.wf",
        "ms6.fr": "ms6.fr"
    }
}
```

A ve variantě `label_value`:

```json
{
    "data": [
        {"label": "ur7.wf", "value": "ur7.wf"},
        {"label": "ms6.fr", "value": "ms6.fr"}
    ]
}
```

**V případě chyby:**

```json
{
    "type": "the_per_minute_quota_has_been_exceeded",
    "code": 400,
    "error": "The per minute quota has been exceeded",
    "detail": null
}
```

Kde:

- **type** a **error** (popis chyby) najdete v [tabulce typů chyb](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňující informace o chybě

### Typy chyb Shortener API

Vedle [obecných typů](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/typy-chyb-api/) vrací tento endpoint vlastní:

| TYP                                     | KDY NASTANE                                                           |
|:----------------------------------------|:-----------------------------------------------------------------------|
| `the_per_minute_quota_has_been_exceeded`| Vyčerpaná kvóta 20 požadavků za minutu.                                |