Pobieranie listy kategorii

Lista kategorii realizowana jest przez wysłanie żądania GET do endpointu /categories.

CURL


curl -X GET https://app.ignitevideo.cloud/api/categories \
-H "Authorization: Bearer YOUR_TOKEN"

JavaScript / Node.js


const response = await fetch('https://app.ignitevideo.cloud/api/categories', {
headers: {
  Authorization: `Bearer YOUR_TOKEN`
}
});

PHP


$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://app.ignitevideo.cloud/api/categories', [
'headers' => [
  'Authorization' => 'Bearer YOUR_TOKEN'
]
]);

Parametry zapytania

Aby uzyskać szczegółowe informacje o wszystkich dostępnych operatorach i zaawansowanym filtrowaniu, zobacz Zapytania. Możesz dodać następujące parametry zapytania URL do żądania:

Parametr	Typ	Opis
`page`	`number`	Numer strony do pobrania (domyślnie: 1).
`limit`	`number`	Liczba kategorii na stronę (domyślnie: 10).
`sort`	`string`	Pole do sortowania. Domyślne sortowanie to `title`.
`where`	`object`	Niestandardowe zapytanie do filtrowania kategorii.
`depth`	`number`	Pomiń `depth`, żeby dostać powiązane obiekty kategorii, takie jak `parent`. Ustaw `depth=0`, żeby dostać identyfikatory.

Klucz API z zakresem listuje tylko kategorie w swoim zakresie kategorii.

Przykład


/api/categories?page=1&limit=10

Odpowiedź API

Odpowiedź to obiekt JSON z następującymi właściwościami:


{
  "docs": [...], // Array of category objects
  "totalDocs": number,
  "limit": number,
  "totalPages": number,
  "page": number,
  "pagingCounter": number,
  "hasPrevPage": boolean,
  "hasNextPage": boolean,
  "prevPage": number | null,
  "nextPage": number | null
}