Vráti zoznam krátkych domén dostupných pre váš účet. Hodnoty z tohto zoznamu patria do parametra `url_type` pri [skracovaní odkazu](https://www.bulkgate.com/sk/dokumentacia/skracovac/skracovac-skratenie-url/).

## API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

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

> [!NOTE]
> Ak sa požiadavka nedostane k cieľu, zopakujte ju na [záložnom serveri](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/zalozny-server/) `backup1.bulkgate.com`.

## Podporované HTTP metódy

- `POST` - `application/json`

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

> [!NOTE]
> API má nastavenú kvótu na `20` požiadaviek za minútu.

## Tabuľka s parametrami

| NÁZOV PARAMETRA   | HODNOTA                                                                       | POVINNÝ | PREDVOLENÁ HODNOTA |
|:------------------|:-------------------------------------------------------------------------------|:--------|:----------------|
| application_id    | [Aplikačný identifikátor](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/)                        | **Áno** | -               | 
| application_token | [Aplikačný overovací token](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/)	                             | **Áno** | -               |
| variant           | Tvar odpovede - `list`, `key_value` alebo `label_value`, pozrite [Tvary odpovede](#tvary-odpovede) | Nie     | `list`          |

### Tvary odpovede

Všetky tri varianty nesú tie isté domény, líšia sa len štruktúrou - vyberte si tú, ktorú priamo spracuje váš formulár.

| HODNOTA       | TVAR `data`                                                |
|:--------------|:-----------------------------------------------------------|
| `list`        | Pole reťazcov.                                             |
| `key_value`   | Objekt, kde kľúč aj hodnota je doména.                     |
| `label_value` | Pole objektov `{"label": …, "value": …}`.                  |

> [!NOTE]
> Zoznam nie je pre všetky účty rovnaký. Obsahuje aj vaše [vlastné domény](https://www.bulkgate.com/sk/centrum-pomoci/kampan/skracovac-url/), ak nejaké máte, a tie sú na jeho začiatku - prvá doména v zozname je zároveň tá, ktorú `shorten` použije, keď `url_type` vynecháte.

## Príklad požiadavky

```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"
}
```

## Odpoveď

**V prípade úspechu:**

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

Ten istý zoznam vo variante `key_value`:

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

A vo variante `label_value`:

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

**V prípade 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) nájdete v [tabuľke typov chýb](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňujúca informácia o chybe

### Typy chýb Shortener API

Popri [všeobecných typoch](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/) vracia tento endpoint vlastné:

| TYP                                     | KEDY NASTANE                                                           |
|:----------------------------------------|:-----------------------------------------------------------------------|
| `the_per_minute_quota_has_been_exceeded`| Vyčerpaná kvóta 20 požiadaviek za minútu.                              |