• polski
  • english

API

Serwis api.sharehost.eu udostępnia API dla zewnętrznych aplikacji i usług. Akceptowane są tylko żądania HTTP typu POST. Wszystkie parametry wejściowe muszą mieć postać niezakodowanego ciągu znaków. Parametry z gwiazdką "*" są obowiązkowe. Pozostałe są opcjonalne.

API zwraca dane w formacie JSON i oferuje wymienione poniżej funkcjonalności. Każda odpowiedź zawiera wartość "success", która określa czy wykonanie danej funkcji zakończyło się powodzeniem. Jeśli nie, wyświetla odpowiedni kod błędu.

Pobranie informacji o stanie swojego konta

Wywołanie

http://sharehost.eu/fapi/userInfo

Parametry wejściowe

  • login* - login użytkownika w serwisie
  • pass* - hasło użytkownika w serwisie

Dane zwracane

  • userLogin - login użytkownika w serwisie
  • userEmail - e-mail użytkownika
  • userIsPremium - określa czy użytkownik w danym momencie posiada dostęp premium (true/false)
  • userPremiumExpire - data wygaśnięcia dostępu premium
  • userTrafficToday - dostępny dzisiaj transfer na pobieranie plików (w bajtach)

Kody błędów

  • emptyLoginOrPassword - nie podano w parametrach loginu lub hasła
  • userNotFound - użytkownik nie istnieje lub podano błędne hasło
  • userNotActive - użytkownik nie aktywował jeszcze konta
  • tooManyLoginsToday - użytkownik przekroczył dzienną liczbę logowań

Przykładowa poprawna odpowiedź

{"success":true,
"data":{"userLogin":"mylogin","userEmail":"[email protected]","userIsPremium":true, "userPremiumExpire":"2016-07-02 16:03:30","userTrafficToday":"15728090505"}}

Przykładowa błędna odpowiedź

{"success":false,"error":"userNotFound"}

Pobranie informacji o pliku

Wywołanie

http://sharehost.eu/fapi/fileInfo

Parametry wejściowe

  • url* - adres URL pliku w dowolnym z formatów generowanych przez serwis
  • filePassword - hasło dostępu do pliku (o ile właściciel je ustanowił)

Dane zwracane

  • fileName - nazwa pliku
  • filePath - ścieżka do katalogu, w którym znajduje się plik
  • fileSize - rozmiar pliku w bajtach
  • fileAvailable - dostępność pliku do pobierania (true/false)
  • fileDescription - opis pliku

Kody błędów

  • emptyUrl - nie podano w parametrach adresu URL pliku
  • invalidUrl - podany adres URL jest w nieprawidłowym formacie, zawiera nieprawidłowe znaki lub jest zbyt długi
  • fileNotFound - nie znaleziono pliku dla podanego adresu URL
  • filePasswordNotMatch - podane hasło dostępu do pliku jest niepoprawne

Wyszukiwanie plików

Wywołanie

http://sharehost.eu/fapi/fileSearch

Parametry wejściowe

  • login* - login użytkownika w serwisie
  • pass* - hasło użytkownika w serwisie
  • searchword* - poszukiwana fraza
  • offset - offset w wyszukanym zbiorze

Dane zwracane

Pole "data" zawiera maksymalnie do 20 obiektów reprezentujących znalezione pliki. Każdy z nich zawiera nastąpujące pola:
  • fileName - nazwa pliku
  • fileSize - rozmiar pliku w bajtach
  • fileUrl - URL do strony pliku

Kody błędów

  • emptyLoginOrPassword - nie podano w parametrach loginu lub hasła
  • userNotFound - użytkownik nie istnieje lub podano błędne hasło
  • userNotActive - użytkownik nie aktywował jeszcze konta
  • tooManyLoginsToday - użytkownik przekroczył dzienną liczbę logowań
  • emptySearchword - nie podano w parametrach poszukiwanej frazy
  • invalidSearchword - podano frazę zbyt długą (max 50 znaków UTF-8) lub zawierającą niedozwolone znaki
  • invalidOffset - podany offset jest nieprawidłowy

Pobranie pliku

Wywołanie

http://sharehost.eu/fapi/fileDownloadLink

Parametry wejściowe

  • login* - login użytkownika w serwisie
  • pass* - hasło użytkownika w serwisie
  • url* - adres URL pliku w dowolnym z formatów generowanych przez serwis
  • filePassword - hasło dostępu do pliku (o ile właściciel je ustanowił)

Dane zwracane

  • fileUrlDownload - link bezpośredni do pobrania pliku, ważny przez 24h

Kody błędów

  • emptyLoginOrPassword - nie podano w parametrach loginu lub hasła
  • userNotFound - użytkownik nie istnieje lub podano błędne hasło
  • userNotActive - użytkownik nie aktywował jeszcze konta
  • tooManyLoginsToday - użytkownik przekroczył dzienną liczbę logowań
  • emptyUrl - nie podano w parametrach adresu URL pliku
  • invalidUrl - podany adres URL jest w nieprawidłowym formacie, zawiera nieprawidłowe znaki lub jest zbyt długi
  • fileNotFound - nie znaleziono pliku dla podanego adresu URL
  • filePasswordNotMatch - podane hasło dostępu do pliku jest niepoprawne
  • userAccountNotPremium - konto użytkownika nie posiada dostępu premium
  • userCanNotDownload - użytkownik nie może pobrać pliku z innych powodów (np. brak transferu)

Wgranie pliku

Wywołanie

http://sharehost.eu/fapi/fileUpload

Ograniczenia

  • maksymalny rozmiar pliku - 2 GB
  • maksymalny czas wgrywania - 10 godzin

Parametry wejściowe

  • login* - login użytkownika w serwisie
  • pass* - hasło użytkownika w serwisie
  • file* - ścieżka dostępu do pliku (jego zawartość musi być umieszczona w danych POST)

Przykładowy skrypt wgrywający plik

$post=array('login'=>'YOUR_LOGIN','pass'=>'YOUR_PASSWORD','file'=>"@"."FULL_PATH_TO_FILE");

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'http://sharehost.eu/fapi/fileUpload');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$postResult = curl_exec($ch);

if (curl_errno($ch))
{
   print curl_error($ch);
   print "Unable to upload file.";
}

curl_close($ch);
print $postResult;

Dane zwracane

  • links - linki do strony załadowanego pliku, we wszystkich dostępnych formatach

Kody błędów

  • emptyLoginOrPassword - nie podano w parametrach loginu lub hasła
  • userNotFound - użytkownik nie istnieje lub podano błędne hasło
  • userNotActive - użytkownik nie aktywował jeszcze konta
  • tooManyLoginsToday - użytkownik przekroczył dzienną liczbę logowań
  • fileNotUploaded - plik nie został załadowany (szczegóły w errorDescription)