Przejdź do treści

Pobierz usage Partner Program

Pobierz managed accounts, active Agents i print jobs dla jednego miesiąca UTC.

GET/partner-api/v1/usageWersja API: v1operationId: getPartnerUsageOtwórz w Markdown

Działanie metody

Pobierz managed accounts, active Agents i print jobs dla jednego miesiąca UTC.

Uwierzytelnianie

Przekaż jednorazowy assertion RS256 Developer Application w Authorization: Bearer <application_assertion>. Nie jest to token dostępu do Public API.

Żądanie

Podstawowy adres API: https://public-api.cloudprint.me/partner-api/v1/usage

Parametry

NazwaPołożenieTypWymaganeOpisOgraniczenia
periodquerystringniePole kontraktu API; uwzględnij podany typ i ograniczenia.example: "2026-08"

Treść żądania

Metoda nie ma treści żądania.

Przykładowe żądania

cURL

bash
curl -sS 'https://public-api.cloudprint.me/partner-api/v1/usage?period=2026-08' \
  -H "Authorization: Bearer $APPLICATION_ASSERTION"

Odpowiedź

Status HTTP: 200 — Żądanie zostało wykonane.

Pola odpowiedzi

NazwaTypWymaganeOpisOgraniczenia
periodstringtakPole kontraktu API; uwzględnij podany typ i ograniczenia.
starts_atstring (date-time)takZnacznik czasu CloudPrint w formacie ISO 8601.
ends_atstring (date-time)takZnacznik czasu CloudPrint w formacie ISO 8601.
managed_accountsintegertakPole kontraktu API; uwzględnij podany typ i ograniczenia.min: 0
active_agentsintegertakPole kontraktu API; uwzględnij podany typ i ograniczenia.min: 0
print_jobsintegertakZadania druku zwrócone dla bieżącego konta i filtrów.min: 0

Przykładowa odpowiedź

json
{
  "period": "string",
  "starts_at": "2026-08-06T12:00:00Z",
  "ends_at": "2026-08-06T12:00:00Z",
  "managed_accounts": 0,
  "active_agents": 0,
  "print_jobs": 0
}

Błędy

Status HTTPOpis
401Brak uwierzytelnienia albo jest ono nieprawidłowe.
403Brak uprawnień wymaganych do tej operacji.
422Pola żądania nie przeszły walidacji.
429Przekroczono limit żądań; zastosuj Retry-After.
500Wewnętrzny błąd CloudPrint.

Wskazówki integracyjne

Powiązana dokumentacja

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