Przejdź do treści

Przegląd CloudPrint Public API

Ta strona opisuje Print API działające w ramach jednego konta. Pełna dokumentacja OpenAPI zawiera również operacje Developer Platform, Partner Management oraz publicznego pobierania Agenta.

Dokąd wysyłać żądania

Serwer wysyła wszystkie żądania API do https://public-api.cloudprint.me. Właściciel konta łączy agentów i tworzy aplikacje API w https://my.cloudprint.me. Zainstalowany agent używa wewnętrznego protokołu CloudPrint i nie jest przeznaczony do bezpośrednich wywołań przez systemy zewnętrzne.

Metody Print API

MetodaŚcieżkaUprawnienieZastosowanie
POST/oauth/tokenPobranie tokenu OAuth2
GET/api/v1/meuwierzytelnienieSprawdzenie konta, aplikacji API i uprawnień
GET/api/v1/agentsagents:readStan i wersja agenta
GET/api/v1/printersprinters:readDrukarki i ich możliwości
POST/api/v1/documentsdocuments:writePrzesłanie PDF lub RAW
POST/api/v1/print-jobsprint_jobs:writeUtworzenie zadania dla dokumentu
POST/api/v1/print-jobs/from-urldocuments:write, print_jobs:writePobranie publicznego HTTPS i utworzenie zadania
POST/api/v1/print-jobs/from-base64documents:write, print_jobs:writeDekodowanie danych osadzonych i utworzenie zadania
GET/api/v1/print-jobsprint_jobs:readLista zadań z paginacją kursorową
GET/api/v1/print-jobs/{printJobId}print_jobs:readOdczyt zadania i wyniku

Kolejność implementacji

Najpierw zaimplementuj token i /me, potem podłączenie drukarki, dokument, idempotentne zadanie i odpytywanie statusu. URL i Base64 dodaj po uruchomieniu procesu dwuetapowego. /agents służy diagnostyce, a lista /print-jobs — uzgadnianiu historii.

Paginacja

Listy agentów, drukarek i zadań używają kursora. Wyślij limit 1–100, potem przekaż nieprzezroczysty next_cursor jako cursor. Zatrzymaj się przy null; nie analizuj i nie konstruuj kursora.

Zgodność

Stabilna ścieżka to /api/v1. Ignoruj nieznane pola i traktuj nieznane statusy jako pośrednie. Używaj wartości dozwolonych i ograniczeń z OpenAPI. Zmiany niezgodne wymagają nowej wersji głównej.

Gdzie szukać

Tokeny: Uwierzytelnianie, wybór drukarki: Agenci i drukarki, dane: Dokumenty, ponowienia i statusy: Zadania, dokładne operacje i schematy: API v1.

Następne kroki

Przewodniki dotyczące integracji CloudPrint, podłączania lokalnego agenta i obsługi procesów drukowania.