- O api
- Api serwisu wklej.to napisane jest przy użyciu
protokołu XML-RPC.
Dlaczego ? Protokół XML-RPC jest bardzo popularnym protokołem, który jest wspierany przez większość języków programowania. Dzięki temu api jest niezależne od platformy oraz języka programowania.
Korzystanie z api jest darmowe i nieograniczone, w przypadku implementacji w serwisach zewnętrznych wymagamy podania informacji o użyciu wklej.to.
- UTF-8
- Zarówno api jak i serwis wklej.to w pełni wspiera kodowanie UTF-8. Api zwraca odpowiedzi również w kodowaniu UTF-8
- Host i port api
- Port: 80, host: api jest dostępne zarówno pod http://wklej.to/api/ oraz https://wklej.to/api/
- Zwracane dane
- Dane zwracane są wg następującego schematu
zawierającego 2 elementy
Jeśli wystąpi błąd:Jeśli proces zakończy się poprawnie:0,'Komunikat błędu'
1,'Zawartość lub komunikat informacyjny'
- Dokumentacja
- Przykład zastosowania api można zobaczyć w kliencie
wklej.to.
Poniżej uproszczona dokumentacja api. W razie pytań prosimy o kontakt.
- create_paste
Służy do dodawania paste, należy określić następujące parametry, wg kolejności:
typ określa typ kolorowania składni, typy są dostępne po wywołaniu komendy types wymagany1 - domyślnie text content zawartość do wklejenia wymagany passwd hasło do usunięcia paste, max 10 znaków opcjonalny - domyślnie brak file_name nazwa pliku wg którego należy określić typ kolorowania opcjonalny2 - domyślnie brak hash jest to hash3 opcjonalnie - domyślnie brak ver wersja klienta wymagany - domyślnie brak 1. w przypadku podania parametru file_name można nie podawać typu.
2. podając file_name nie trzeba podawać parametru type, podanie type spowoduje określenie wg niego.
3. Jeśli podasz hash zawartość paste zostanie zaszyfrowana i nie będzie możliwości odzyskania zawartości, przechowujemy tylko zahashowane wersje paste.Zwrócona wartość to pełny link do paste lub komunikat błędu
- get_paste
Służy do pobierania paste, należy określić następujące parametry, wg kolejności:
uid określa uid paste do pobrania, można podać cały url wymagany typ określa typ wyjścia dostępne typy: text,html,svg,latex,rtf,pdf1 wymagany - domyślnie text hash jest to hash2 opcjonalnie - domyślnie brak ver wersja klienta wymagany - domyślnie brak 1. W przypadku pdf zwrocona zawartość jest zakodowana w Base64
2. Jeśli podasz błędny hash zawartość paste będzie ciągle zaszyfrowana, może to powodować błędy w działaniu aplikacji po twojej stronie.Zwrócona wartość to dana paste w wybranym typie, lub komunikat błędu
- remove_paste
Służy do usuwania paste, należy określić następujące parametry, wg kolejności:
uid określa uid paste do usunięcia, można podać cały url wymagany password hasło do usunięcia paste opcjonalny ver wersja klienta wymagany - domyślnie brak Zwrócona wartość to komunikat o powodzeniu lub o błędzie
- types
Zwraca wszystkie dostępne typy kolorowania składni
- server_ver
Zwraca wersje serwera.
- create_paste