Zkrácení URL

Definice akce

Tento api endpoint se používá ke zkrácení url, pro budoucí použití v portálu BulkGate.

API URL

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

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

POST /api/1.0/shortener/shorten HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

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	-
target_url	Url ke zkrácení	Ano	-
url_type	Doména (ur7.fr, u1.pm, ms6.fr, ms6.cz, msg.bg)	Ne	u1.pm

Příklad úplného požadavku

POST /api/1.0/shortener/shorten HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
Cache-Control: no-cache

{
  "application_id": "APPLICATION_ID",
  "application_token": "APPLICATION_TOKEN",     
  "target_url": "www.bulkgate.com",
  "url_type": "u1.pm"
}

Odpověď na tento příkaz může být:

V případě úspěchu:

{
    "data": {
        "short_url": "http://u1.pm/W",
        "target_url": "http://bulkgate.com",
        "final_url": "https://www.bulkgate.com/en/",
        "title": "SMS & other channels for business communication | BulkGate"
    }
}

V případě chyby:

{
    "type": "url_is_not_valid",
    "code": 400,
    "error": "Url is not valid",
    "detail": null
}

{
    "type": "url_type_is_incorrect",
    "code": 400,
    "error": "Url type is incorrect",
    "detail": null
}

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

{
    "type": "url_is_unavailable",
    "code": 400,
    "error": "Url is unavailable",
    "detail": null
}