Dokumentacja CloudPrint API v1
Wersjonowana dokumentacja CloudPrint API dotycząca uwierzytelniania, drukarek, dokumentów, zadań, błędów i bezpiecznych ponowień.
Jak korzystać z dokumentacji
Szybki start i przewodniki wyjaśniają cały proces biznesowy. Wersjonowana dokumentacja API służy do wdrażania konkretnych żądań, pól, odpowiedzi i obsługi błędów. Interaktywny podgląd jest narzędziem pomocniczym; każda publiczna operacja jest dostępna w statycznym HTML i Markdown.
Podstawowy adres i przebieg integracji
Żądania produkcyjne są wysyłane na https://public-api.cloudprint.me. Typowa integracja pobiera token, wybiera drukarkę, przesyła dokument, tworzy idempotentne zadanie i sprawdza je aż do stanu końcowego.
Gwarancje zgodności
Wersja główna jest częścią stabilnej ścieżki API. Zgodne rozszerzenia mogą pojawiać się w v1; usunięcie lub zmiana nazw operacji i pól wymaga nowej wersji głównej.
Co robi CloudPrint
CloudPrint dostarcza gotowy PDF lub jawne dane RAW języka drukarki na wybraną lokalną drukarkę przez wychodzące połączenie agenta. Public API nie generuje etykiet przewoźnika, nie konwertuje dokumentów Office i nie udostępnia wewnętrznego protokołu agenta.
Wszystkie operacje API v1
| Typ | Opis | Ścieżka |
|---|---|---|
POST | Pobieranie tokenu | /oauth/token |
POST | Token instalacji | /developer-api/v1/app-installations/{installationId}/access-tokens |
GET | Wersje agenta | /agent-download-api/v1/releases |
GET | Pobieranie agenta | /agent-download-api/v1/installers/{filename} |
GET | Lista kont klientów | /partner-api/v1/accounts |
POST | Tworzenie konta | /partner-api/v1/accounts |
GET | Pobieranie konta | /partner-api/v1/accounts/{relationshipId} |
GET | Lista Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments |
POST | Tworzenie Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments |
GET | Pobieranie Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId} |
DELETE | Odwołanie Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId} |
GET | Lista agentów klienta | /partner-api/v1/accounts/{relationshipId}/agents |
DELETE | Odwołanie agenta klienta | /partner-api/v1/accounts/{relationshipId}/agents/{agentId} |
GET | Statystyki kont | /partner-api/v1/usage |
POST | Zmiana stanu konta | /partner-api/v1/accounts/{relationshipId}/{action} |
GET | Kontekst klienta | /api/v1/me |
GET | Lista agentów | /api/v1/agents |
GET | Lista drukarek | /api/v1/printers |
POST | Przesyłanie dokumentu | /api/v1/documents |
GET | Lista zadań | /api/v1/print-jobs |
POST | Tworzenie zadania | /api/v1/print-jobs |
POST | Tworzenie z URL | /api/v1/print-jobs/from-url |
POST | Tworzenie z Base64 | /api/v1/print-jobs/from-base64 |
GET | Status zadania | /api/v1/print-jobs/{printJobId} |