ElibriAPI abstrahuje wykorzystanie API udostępniane przez eLibri. Więcej...
Metody publiczne | |
| __construct ($token, $secret, $host="https://www.elibri.com.pl") | |
| Kontruktor obiektu API. Więcej... | |
| watermark ($ident, $formats, $visible_watermark, $title_postfix, $customer_ip=NULL, $client_symbol=NULL) | |
| Zlecaj watermarkowanie. Żeby skrócić maksymalnie oczekiwanie klienta na plik, podzieliliśmy cały proces watermarkingu na dwa etapy. Proponujemy, żeby zlecać watermarking tak wcześnie, jak to tylko możliwe (na przykład wtedy, gdy klient opuści koszyk, i poda swoje dane) eLibri rozpoczyna wtedy watermarkowanie książki, ale nie udostępnia jeszcze pliku sklepowi, ani nie rejestruje transakcji. Dopiero po dokonaniu płatności przez klienta należy wywołać metodę deliver, która to dostarczy plik do sklepu. Po umieszczeniu pliku na S3 nasz serwer łączy się z przekazanym przez Państwa URL-em (metoda POST), przekazując w parametrze trans_id identyfikator transakcji, która została ukończona. Więcej... | |
| deliver ($trans_id) | |
| Dostarcz plik oraz zajestruj transakcję Ta metoda powinna zostać wywołana po watermark. Sklep powinien ją wywołać po zarejestrowaniu płatności przez klienta. Zwatermarkowany plik (pliki) zostaną przekopiowane do bucketu na amazon S3, który jest przypisany do sklepu. Sklep jest zobowiązany do wykasowania pliku po jego ściągnięciu. Więcej... | |
| retry ($trans_id) | |
| Zleca ponowne watermarkowanie wcześniej zakupionego pliku Sklep nie jest zobowiązany do przechowywania zwatermarkowanego pliku dłużej, niż 7 dni. Po tym czasie może wykasować plik, a jeśli klient będzie chciał ponownie pobrać plik, to można zlecić jego watermarkowanie poprzez retry. Każde wywołanie retry zwraca nowy identyfikator transakcji - należy go zapisać w swojej lokalnej bazie danych. Nie ma limitu wywołań retry, nie mogą one jednak występować częściej, niż co 7 dni. Przy kolejnym wywołaniu retry należy podać $trans_id pochodzący z poprzedniego wywołania retry. Operacje retry są bezpłatne, i nie są raportowane jako nowa sprzedaż. Zwracany jest nowy identyfikator transakcji, który trzeba zapisać w systemie (np. w miejsce poprzedniego identyfikatora). Po wywołaniu retry niezbędne jest wywołanie metody deliver z nowootrzymanym identyfikatorem transakcji. Więcej... | |
| available_files () | |
| Pobierz listę dostępnych plików Za pomocą tej metody możesz pobrać listę książek, które są lub będą w najbliższym czasie dostępne w systemie eLibri. | |
| soon_available_files () | |
| Ponierz listę plików, których premiera się zbliża Za pomocą tej metody możesz pobrać listę ksiażek, które nie są w tej chwili dostępne, ale ich premiera jest wkrótce. | |
| soon_unavailable_files () | |
| Ponierz listę plików, które wkrótce przestaną być dostępne Za pomocą tej metody możesz pobrać listę ksiażek, które wkrótce przestaną być dostępne. | |
Opis szczegółowy
ElibriAPI abstrahuje wykorzystanie API udostępniane przez eLibri.
Dokumentacja konstruktora i destruktora
◆ __construct()
| ElibriWatermarkingClient::__construct | ( | $token, | |
| $secret, | |||
$host = "https://www.elibri.com.pl" |
|||
| ) |
Kontruktor obiektu API.
- Parametry
-
String $token - publiczny token eLibri Watermarking API String $secret - prywatny token eLibri Watermarking API Array $subdomains - lista subdomen, opcjonalnie. Przydatne, gdy używana wersja PHP nie zawiera metody dns_get_record
Dokumentacja funkcji składowych
◆ deliver()
| ElibriWatermarkingClient::deliver | ( | $trans_id | ) |
Dostarcz plik oraz zajestruj transakcję Ta metoda powinna zostać wywołana po watermark. Sklep powinien ją wywołać po zarejestrowaniu płatności przez klienta. Zwatermarkowany plik (pliki) zostaną przekopiowane do bucketu na amazon S3, który jest przypisany do sklepu. Sklep jest zobowiązany do wykasowania pliku po jego ściągnięciu.
- Parametry
-
String $trans_id - alfanumeryczny identyfikator transakcji zwrócony przez metodę watermark
◆ retry()
| ElibriWatermarkingClient::retry | ( | $trans_id | ) |
Zleca ponowne watermarkowanie wcześniej zakupionego pliku Sklep nie jest zobowiązany do przechowywania zwatermarkowanego pliku dłużej, niż 7 dni. Po tym czasie może wykasować plik, a jeśli klient będzie chciał ponownie pobrać plik, to można zlecić jego watermarkowanie poprzez retry. Każde wywołanie retry zwraca nowy identyfikator transakcji - należy go zapisać w swojej lokalnej bazie danych. Nie ma limitu wywołań retry, nie mogą one jednak występować częściej, niż co 7 dni. Przy kolejnym wywołaniu retry należy podać $trans_id pochodzący z poprzedniego wywołania retry. Operacje retry są bezpłatne, i nie są raportowane jako nowa sprzedaż. Zwracany jest nowy identyfikator transakcji, który trzeba zapisać w systemie (np. w miejsce poprzedniego identyfikatora). Po wywołaniu retry niezbędne jest wywołanie metody deliver z nowootrzymanym identyfikatorem transakcji.
- Parametry
-
String $trans_id - alfanumeryczny identyfikator transakcji zwrócony przez metodę watermark lub retry
- Zwraca
- $transid - alfanumeryczny identyfikator nowej transakcji
◆ watermark()
| ElibriWatermarkingClient::watermark | ( | $ident, | |
| $formats, | |||
| $visible_watermark, | |||
| $title_postfix, | |||
$customer_ip = NULL, |
|||
$client_symbol = NULL |
|||
| ) |
Zlecaj watermarkowanie. Żeby skrócić maksymalnie oczekiwanie klienta na plik, podzieliliśmy cały proces watermarkingu na dwa etapy. Proponujemy, żeby zlecać watermarking tak wcześnie, jak to tylko możliwe (na przykład wtedy, gdy klient opuści koszyk, i poda swoje dane) eLibri rozpoczyna wtedy watermarkowanie książki, ale nie udostępnia jeszcze pliku sklepowi, ani nie rejestruje transakcji. Dopiero po dokonaniu płatności przez klienta należy wywołać metodę deliver, która to dostarczy plik do sklepu. Po umieszczeniu pliku na S3 nasz serwer łączy się z przekazanym przez Państwa URL-em (metoda POST), przekazując w parametrze trans_id identyfikator transakcji, która została ukończona.
- Parametry
-
String $ident - ISBN13 (bez myślików), lub record_reference String $formats - 'mobi', 'epub', lub 'mobi,epub' String $visible_watermark - stopka doklejana na końcu każdego rozdziału String $title_postfix - tekst doklejany do tytułu książki String $customer_ip - numer IP klienta, używany w celach wyłącznie statystycznych String $client_symbol - opcjonalny identyfikator promocji
- Zwraca
- $transid - alfanumeryczny identyfikator transakcji
