Returnerer listen over korte domener som er tilgjengelige for kontoen din. Verdiene fra denne listen er det som hører hjemme i parameteren `url_type` når du [forkorter en lenke](https://www.bulkgate.com/no/dokumentasjon/lenkeforkorter/lenkeforkorter-forkort-url/).

## API-URL

URL som brukes til å sende HTTP-forespørslene:

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

> [!NOTE]
> Hvis forespørselen ikke kommer frem, gjentar du den på [reserveserveren](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-reserveserver/) `backup1.bulkgate.com`.

## Støttede HTTP-metoder

- `POST` - `application/json`

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

> [!NOTE]
> API-et har en kvote på `20` forespørsler per minutt.

## Parametertabell

| PARAMETERNAVN     | VERDI | OBLIGATORISK | STANDARDVERDI |
|:------------------|:------|:-------------|:--------------|
| application_id    | [Application ID](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/administrasjon-av-api/) | **Ja** | - | 
| application_token | [Applikasjonens autentiseringstoken](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-token/) | **Ja** | - |
| variant           | Formen på svaret - `list`, `key_value` eller `label_value`, se [Former for svaret](#former-for-svaret) | Nei | `list` |

### Former for svaret

Alle tre variantene inneholder de samme domenene og skiller seg bare i struktur - velg den som skjemaet ditt kan bruke direkte.

| VERDI         | FORMEN PÅ `data` |
|:--------------|:-----------------|
| `list`        | En matrise med strenger. |
| `key_value`   | Et objekt der både nøkkelen og verdien er domenet. |
| `label_value` | En matrise med objekter av typen `{"label": …, "value": …}`. |

> [!NOTE]
> Listen er ikke den samme for alle kontoer. Den inneholder også dine [egne domener](https://www.bulkgate.com/no/hjelpesenter/kampanjer/lenkeforkorter-kampanje/) hvis du har noen, og de kommer først - det første domenet i listen er også det som `shorten` bruker når du utelater `url_type`.

## Eksempel på forespørsel

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

## Svar

**Ved suksess:**

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

Den samme listen i varianten `key_value`:

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

Og i varianten `label_value`:

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

**Ved feil:**

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

Der:

- **type** og **error** (beskrivelse av feilen) finner du i [tabellen over feiltyper](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-feiltyper/)
- **code** er HTTP-feilkoden
- **detail** er tilleggsinformasjon om feilen

### Feiltyper i Shortener API

I tillegg til de [generelle typene](https://www.bulkgate.com/no/dokumentasjon/api-administrasjon/api-feiltyper/) returnerer dette endepunktet sine egne:

| TYPE                                    | NÅR DET SKJER |
|:----------------------------------------|:--------------|
| `the_per_minute_quota_has_been_exceeded`| Kvoten på 20 forespørsler per minutt er brukt opp. |