Spoti.pl

x

Dla programistów

spoti.pl umożliwia wykorzystanie zgromadzonych publikacji w innych serwisach na dwa sposoby:

  • za pomocą osadzonego readera - więcej o tym czytaj tutaj: Pomoc
  • za pomocą otwartego interfejsu dla programistów(API)

Za pomocą udostępnionych metod API programiści mogą budować nowe serwisy, aplikacje i gadżety.

Przed rozpoczęciem korzystanie z API napisz do nas, aby uzyskać swój darmowy, unikalny klucz identyfikacyjny API.

Poniżej znajdziesz informacje o wszystkich udostępnionych metodach:

FileUploadService.FileUpload

Upload pliku przy pomocy formularza z enctype="multipart/form-data"

Parametry

  • apiKeyklucz api - wymagane (np:A00CB4C1-58C1-4E4A-8212-4222268E3E17)
  • accesstyp dostepu fo pliku prywatny/aktywny (wartości: [ Private; Public ]) - domyslnie 'Private'
  • allowCopyingczy zezwala na kopiowanie zawartosci pliku (wartości: [ true; false ]) - domyslnie 'false'
  • allowDownloadingczy zezwala na sciaganie pliku (wartości: [ true; false ]) - domyslnie 'false'
  • allowPrintingczy zezwala na drukowanie (wartości: [ true; false ]) - domyslnie 'false'
  • categoryidid kategorii - wymagane (identyfikator kategorii, np pobrany za pomoca funkcji spoti.getCategory)
  • confirmationOfPublishingRightspotwierdzenie praw do publikacji - wymagane (wartości: [ true; false ]) - domyslnie 'false'
  • defaultViewTypedefaultowy widok dokumentu (wartości: [ Classic; Scroll; Slideshow; Thumbnails; Flow ]) - domyślnie'Scroll'
  • descriptionopis dokumentu
  • freePagesdarmowe strony (w formacie "1;2;3;7;172") - ma sens tylko kiedy flaga 'isChergeable' ustawiona jest na 'true'
  • isAdultRestrictedczy jest ograniczone wiekiem (wartości: [ true; false ]) - domyslnie 'false'
  • isChergeableczy jest platny (wartości: [ true; false ]) - domyslnie 'false'
  • languagejezyk dokumentu (wartości: [ Polish; English ]) - domyslnie 'Polish'
  • licensetyp licencji (wartości: [ Attribution; AttributionShareAlike; AttributionNoDerivatives; AttributionNonCommercial; AttributionNonCommercialShareAlike; AttributionNonCommercialNoDerivatives ]) - domyslnie 'Attribution'
  • pricecena (np: 10,99)
  • tagstagi (w formacie "tag1;tag2;tag3")
  • titletytul dokumentu
  • hashhash autoryzacyjny- wymagane (obliczony zgodnie z instrukcją)

SpotiService.Search

wyszukiwanie w kaktalogu

Parametry

  • querywyszukiwana fraza
  • categoryIdfiltr : kategoria - identyfikator kategorii - moze byc pobrany za pomoca metody spoti.getCategory
  • userIdfiltr : user - identyfikator użytkownika - narazie nie ma jak pobrac
  • scopeczy wyszukujemy w calum katalogu czy tylko publikacjach klienta api (wartości : [ spoti; account ]) domyślnie 'account'
  • licenseTypefiltr : typ licencji (wartości: [ Attribution; AttributionShareAlike; AttributionNoDerivatives; AttributionNonCommercial; AttributionNonCommercialShareAlike; AttributionNonCommercialNoDerivatives ]) - domyślnie nie ustawione
  • isChergeablefiltr : platne/bezplatne publikacje (wartości: [ true; false ]) - domyslnie nieustawione
  • documentLanguageIdfiltr na jezyk dokumentu (wartości: [ Polish; English ]) - domyslnie nieustawione
  • lowerPricefiltr : dolna granica ceny
  • upperPricefiltr : gorna granica ceny
  • lowerPageNfiltr : minimalna ilosc stron
  • upperPageNfiltr : maksymalna ilosc stron
  • sortFieldtyp sortowania (wartości : [ rating, createDate, score, documentPrice, documentLicenceTypeId] ) - domyślnie 'createDate'
  • sortDirectionkierunek sortowania (wartości : [ desc; asc ] domyslnie 'desc'
  • pageIndexnr strony
  • pageSizewielkosc strony
  • apiKeyklucz api - wymagany

SpotiService.GetList

pobiera liste dokumentow

Parametry

  • userIdfiltr : user - identyfikator użytkownika - narazie nie ma jak pobrac
  • scopeczy wyszukujemy w calum katalogu czy tylko publikacjach klienta api (wartości : [ spoti; account ]) domyślnie 'account'
  • sortFieldtyp sortowania (wartości : [ rating, createDate, score, documentPrice, documentLicenceTypeId] ) - domyślnie 'createDate'
  • sortDirectionkierunek sortowania (wartości : [ desc; asc ] domyslnie 'desc'
  • pageIndexnr strony
  • pageSizewielkosc strony
  • apiKeyklucz api - wymagane

SpotiService.GetConversionStatus

pobiera status przetwarzania dokumentu

Parametry

  • apiKeyklucz api - wymagane
  • documentIdidentyfikator dokuemtnu - wymagane

SpotiService.GetCategory

pobiera kategorie, jezeli categoryId nie jest ustawione zwróci wszystkie, jezeli jet to tylko ją, ewentualnie podkategorie

Parametry

  • categoryIdid kategorii glownej
  • includeSubcategoriesczy zwrocic podkategorie (wartości : [ true; false ] - domyślnie true)
  • apiKeyklucz api - wymagany

SpotiService.Featured

pobiera dokumenty promowane

Parametry

  • apiKeyklucz api - wymagany
  • documentFeatureTypetyp listy - narazie nie zaimplementowane - dod dogadania
  • pageIndexnr strony
  • pageSizewielkosc strony

SpotiService.GetDownloadUrl

pobiera adres url pliku do pobrania

Parametry

  • apiKeyklucz api - wymagane
  • documentIdidentyfikator dokumentu - wymagane
  • typetyp dokumentu - (wartości : [ pdf; txt; source; ] - domyślnie 'pdf')
  • hashhasz autoryzacyjny - wymagane jezli dokument jest płatny

Pomoc