Dokumentacja CloudPrint/Dokumentacja API

Wersjonowanie CloudPrint API

Poznaj gwarancje zgodności v1, dozwolone rozszerzenia, zasady wydawania niezgodnych wersji, wycofywania i migracji.

Wersja API: v1Pobierz OpenAPI v1 w formacie JSONOtwórz interaktywną dokumentację APIOtwórz w Markdown

Wersja główna w adresie

CloudPrint zapisuje granicę zgodności w /api/v1, a dokumentacja używa /docs/api/v1/. Wersje aplikacji takie jak 0.7.1 nie są wersjami API.

Zgodne zmiany v1

W v1 mogą zostać dodane metody, opcjonalne pola żądań, pola odpowiedzi, dozwolone wartości i statusy pośrednie. Klient musi ignorować nieznane pola odpowiedzi i poprawnie obsługiwać nowe statusy niekońcowe.

Zmiany niezgodne

Usunięcie lub zmiana nazwy operacji lub pola, dodanie pola wymaganego, zmiana typu albo wymagań autoryzacji wymaga nowej wersji głównej i przewodnika migracji.

Wycofywanie wersji

Planowane wycofanie wersji jest ogłaszane w historii zmian API i przewodniku migracji. Gdy ma to zastosowanie, odpowiedzi wcześniej otrzymują standardowe nagłówki Deprecation i Sunset.

Powiązana dokumentacja

Historia zmian CloudPrint APIZmiany kontraktu i dokumentacji Public API niezależnie od wydań produktu CloudPrint.Dokumentacja CloudPrint API v1Wersjonowana dokumentacja CloudPrint API dotycząca uwierzytelniania, drukarek, dokumentów, zadań, błędów i bezpiecznych ponowień.Interaktywny CloudPrint API v1Interaktywny podgląd pełnego kontraktu OpenAPI CloudPrint API v1, schematów i przykładów.

OpenAPIOtwórz panelPolityka prywatnościRegulaminPłatności i zwrotyDPA