Dostupné domény

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.

API URL

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

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

Poznámka

Nedostane-li se požadavek k cíli, zopakujte ho na záložním serveru backup1.bulkgate.com.

Podporované HTTP metody

POST - application/json

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

Poznámka

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	Ano	-
application_token	Aplikační ověřovací token	Ano	-
variant	Tvar odpovědi - `list`, `key_value` nebo `label_value`, viz Tvary odpovědi	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": …}`.

Poznámka

Seznam není pro všechny účty stejný. Obsahuje i vaše vlastní domény, 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

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:

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

Tentýž seznam ve variantě key_value:

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

A ve variantě label_value:

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

V případě chyby:

{ "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
code je HTTP kód chyby
detail je doplňující informace o chybě

Typy chyb Shortener API

Vedle obecných typů vrací tento endpoint vlastní:

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

Byla tato stránka užitečná?

Zeptat se AI Zkopírováno