API dla programistów
Wywołuj narzędzia ze swojego oprogramowania bez przeglądarki: wyślij żądanie, uruchom zadanie i pobierz wynik. Wszystkie endpointy znajdują się pod jednym wersjonowanym adresem; każde żądanie jest autoryzowane kluczem osobistym.
Przebieg zadania
Jedno wywołanie uruchamia zadanie konwersji i zwraca ID zadania. Za pomocą tego ID sprawdzasz status zadania i pobierasz wynik po jego ukończeniu. Zadania mogą chwilę potrwać, więc ten podział pozwala klientom czekać bez blokowania ich pracy.
Klucz i dostęp
Żądania są podpisywane nagłówkiem Authorization: Bearer. Utwórz klucz na swoim koncie i unieważnij go w dowolnym momencie; zwykły tekst klucza jest widoczny tylko w chwili utworzenia. Sesja przeglądarki nie liczy się tutaj jako autoryzacja.
Narzędzia z otwartym API
| Narzędzie | Zakres API | Dokument |
|---|---|---|
| ObrazMini | Konwerter — POST /run | Dokument |
| Księga Przychodów i Wydatków | 10 endpointów (aplikacja stanowa) | Dokument |
| PdfSplit | Konwerter — POST /run | Dokument |
Wersjonowanie i kontrakt
Endpointy są wersjonowane pod https://api.pixepi.com z prefiksem /api/v1; zmiana niekompatybilna wstecz wymaga nowej wersji. Kontrakt maszynowy jest publikowany jako OpenAPI 3.1 i można go przekazać bezpośrednio do generatorów klientów.
Odpowiedzi i błędy
Odpowiedzi znajdują się w kopercie JSON; każde zadanie jest odpytywane po własnym ID, a prawo własności rekordu jest sprawdzane na serwerze. Gdy coś pójdzie nie tak, odpowiedź zwraca kod opisujący ten stan; klient tłumaczy ten kod na swój własny język.
Więcej szczegółów
- Link do API na stronie wybranego narzędzia; otwiera endpointy, pola żądań, opcje i obsługę błędów tego narzędzia.
- Kontrakt maszynowy: dokument OpenAPI.
- Główna strona dla programistów: wspólna lista wszystkich endpointów.