Przegląd
Nasze API pozwala stworzyć krótkie url do każdej z istniejących witryn. Podczas rejestracji konta, otrzymasz wygenerowany unikalny klucz API, który powinien być używany w wywołaniach API wymienionych poniżej.
Poniższe przykłady generowania odpowiedzi w formacie JSON, ale można również użyć xml zastępując koniec call url z .xml.
Utwórz
Utwórz nowy krótki URL podająć zakodowaną wersję base64 długiego URL.
Parametry:
Imię: |
Typ: |
Opis: |
key |
string |
Twój klucz dostępu API. Zaloguj się by zobaczyć |
url |
string |
Base64 zdekodowana wersja Twojego długiego URL. base64_encode() w PHP. |
Zwracane wartości:
Imię: |
Typ: |
Opis: |
url_id |
liczba całkowita |
Unikalny URL id. |
short_url |
string |
Krótki adres URL zawierający adres domeny. |
short_url_part |
string |
Część krótkiego adresu URL. (bez nazwy domeny) |
original_url |
string |
Oryginalny zdekodowany długi URL. |
date_time |
string |
Data i czas połączenia API. Format: yyyy-mm-dd hh:mm:ss. |
Przykładowe zapytanie:
API Address: https://xurl.pl
GET //api/v1/0f78c7a5773ec10d62748e4140c78cc6/shorturl/create/url/BASE64_ENCODED_LONG_URL.json
Przykładowa odpowiedź:
{
"code":200,
"data":{
"url_id":"1388597",
"short_url":"https://xurl.pl/srt",
"short_url_part":"srt",
"original_url":"http://www.bbc.co.uk",
"date_time":"2013-04-04 16:18:05"
}
}
Utwórz (dodatkowe Opcje)
Create a new short url including some additional settings such as a custom short url, password to access and an expiry date.
Parametry:
Imię: |
Typ: |
Opis: |
key |
string |
Twój klucz dostępu API. Zaloguj się by zobaczyć |
url |
string |
Base64 zdekodowana wersja Twojego długiego URL. base64_encode() w PHP. |
custom_url (optional) |
string |
Część krótkiego url. |
password (optional) |
string |
Hasło dostępu do adresu URL. |
expiry_date (optional) |
string |
Data wygaśnięcia adresu URL. Format: yyyy-mm-dd. |
base_domain (optional) |
string |
Url używany do skracania linków. Musi występować na stronie, bez http:// np. domena.pl |
Zwracane wartości:
Imię: |
Typ: |
Opis: |
url_id |
liczba całkowita |
Unikalny URL id. |
short_url |
string |
Krótki adres URL zawierający adres domeny. |
short_url_part |
string |
Część krótkiego adresu URL. (bez nazwy domeny) |
original_url |
string |
Oryginalny zdekodowany długi URL. |
date_time |
string |
Data i czas połączenia API. Format: yyyy-mm-dd hh:mm:ss. |
Przykładowe zapytanie:
API Address: https://xurl.pl
GET //api/v1/0f78c7a5773ec10d62748e4140c78cc6/shorturl/create/custom_url/CUSTOM_SHORT_URL/password/PASSWORD_TO_ACCESS/expiry_date/URL_EXPIRY_DATE/url/BASE64_ENCODED_LONG_URL.json
Przykładowa odpowiedź:
{
"code":200,
"data":{
"url_id":"1388598",
"short_url":"https://xurl.pl/bbc",
"short_url_part":"bbc",
"original_url":"http://www.bbc.co.uk",
"date_time":"2013-04-04 16:18:08"
}
}
Wyłącz
Disable an active short url within your account.
Parametry:
Imię: |
Typ: |
Opis: |
key |
string |
Twój klucz dostępu API. Zaloguj się by zobaczyć |
short_url |
string |
Base64 zdekodowana wersja Twojego krótkiego URL. base64_encode() w PHP. |
Zwracane wartości:
Imię: |
Typ: |
Opis: |
url_id |
liczba całkowita |
Unikalny URL id. |
status |
string |
Status krótkiego adresu URL. |
short_url |
string |
Krótki adres URL zawierający adres domeny. |
date_time |
string |
Data i czas połączenia API. Format: yyyy-mm-dd hh:mm:ss. |
Przykładowe zapytanie:
API Address: https://xurl.pl
GET //api/v1/0f78c7a5773ec10d62748e4140c78cc6/shorturl/disable/short_url/BASE64_ENCODED_SHORT_URL.json
Przykładowa odpowiedź:
{
"code":200,
"data":{
"url_id":"1388598",
"status":"disabled",
"short_url":"https://xurl.pl/bbc",
"date_time":"2013-04-04 17:01:42"
}
}
Aktywuj
Activate a disabled short url within your account.
Parametry:
Imię: |
Typ: |
Opis: |
key |
string |
Twój klucz dostępu API. Zaloguj się by zobaczyć |
short_url |
string |
Base64 zdekodowana wersja Twojego krótkiego URL. base64_encode() w PHP. |
Zwracane wartości:
Imię: |
Typ: |
Opis: |
url_id |
liczba całkowita |
Unikalny URL id. |
status |
string |
Status krótkiego adresu URL. |
short_url |
string |
Krótki adres URL zawierający adres domeny. |
date_time |
string |
Data i czas połączenia API. Format: yyyy-mm-dd hh:mm:ss. |
Przykładowe zapytanie:
API Address: https://xurl.pl
GET //api/v1/0f78c7a5773ec10d62748e4140c78cc6/shorturl/enable/short_url/BASE64_ENCODED_SHORT_URL.json
Przykładowa odpowiedź:
{
"code":200,
"data":{
"url_id":"1388598",
"status":"active",
"short_url":"https://xurl.pl/bbc",
"date_time":"2013-04-04 17:01:42"
}
}
Info
Get detailed information for any short url within your account.
Parametry:
Imię: |
Typ: |
Opis: |
key |
string |
Twój klucz dostępu API. Zaloguj się by zobaczyć |
short_url |
string |
Base64 zdekodowana wersja Twojego krótkiego URL. base64_encode() w PHP. |
Zwracane wartości:
Imię: |
Typ: |
Opis: |
url_id |
liczba całkowita |
Unikalny URL id. |
short_url |
string |
Krótki adres URL zawierający adres domeny. |
short_url_part |
string |
Część krótkiego adresu URL. (bez nazwy domeny) |
original_url |
string |
Oryginalny zdekodowany długi URL. |
date_created |
string |
Data/czas utworzenia krótkiego adresu URL |
last_accessed |
string |
Data/czas ostatniego wejścia na krótki adres URL |
total_visits |
liczba całkowita |
Liczba odwiedzin |
has_password |
bool |
Czy adres URL wymaga hasła dostępu. |
expiry_date |
string |
Data/czas wygaśnięcia krótkiego adresu URL |
status |
string |
Status krótkiego adresu URL. |
date_time |
string |
Data i czas połączenia API. Format: yyyy-mm-dd hh:mm:ss. |
Przykładowe zapytanie:
API Address: https://xurl.pl
GET //api/v1/0f78c7a5773ec10d62748e4140c78cc6/shorturl/info/short_url/BASE64_ENCODED_SHORT_URL.json
Przykładowa odpowiedź:
{
"code":200,
"data":{
"url_id":"13423436",
"short_url":"https://xurl.pl/bbc",
"short_url_part":"bbc",
"original_url":"http://www.bbc.co.uk",
"date_created":"2013-04-04 12:36:09",
"last_accessed":"2013-05-02 12:32:05",
"total_visits":"3452",
"has_password":true,
"expiry_date":"2019-03-02 23:59:59",
"status":"active",
"date_time":"2013-04-04 17:10:14"
}
}
Lista
List all active urls within your account.
Parametry:
Imię: |
Typ: |
Opis: |
key |
string |
Twój klucz dostępu API. Zaloguj się by zobaczyć |
Zwracane wartości:
Imię: |
Typ: |
Opis: |
urls |
szyk |
Lista krótkich adresów URL w koncie. |
date_time |
string |
Data i czas połączenia API. Format: yyyy-mm-dd hh:mm:ss. |
Przykładowe zapytanie:
API Address: https://xurl.pl
GET //api/v1/0f78c7a5773ec10d62748e4140c78cc6/shorturl/list_active_urls.json
Przykładowa odpowiedź:
{
"code":200,
"data":{
"urls":[
{
"short_url":"https://xurl.pl/2F"
},
{
"short_url":"https://xurl.pl/2q"
}
],
"date_time":"2013-04-09 09:48:05"
}
}