> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Pobieranie listy dokumentów platformy AceDataCloud

> Platform API guide - Ace Data Cloud

Zwraca stronicowaną listę dokumentów deweloperskich widocznych w bieżącej witrynie, którą można wykorzystać do wyszukiwania, indeksowania lub samodzielnego budowania nawigacji po stronie klienta. Lista obecnie zawiera `content` każdej dokumentacji oraz zagnieżdżone informacje o elemencie nadrzędnym, a odpowiedź może być duża.

## Przegląd interfejsu API

| Pozycja | Treść |
| - | - |
| Metoda | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/documents/` |
| Uwierzytelnianie | Publiczne; użytkownicy niebędący administratorami nie widzą dokumentów private |
| Stronicowanie | `count` + `items` |

## Parametry zapytania

| Parametr | Typ | Wymagany | Domyślnie | Opis |
| - | - | - | - | - |
| `id` | UUID | Nie | — | Filtruje według ID dokumentu; obsługuje powtarzane parametry |
| `private` | boolean | Nie | — | Filtruje według statusu private; użytkownicy niebędący administratorami nadal nie widzą dokumentów prywatnych |
| `type` | string | Nie | — | Precyzyjnie filtruje według rzeczywistej wartości `type` dokumentu |
| `tag` | string | Nie | — | Filtruje według tagu |
| `limit` | integer | Nie | 10 | Liczba elementów na stronę, maksymalnie 100 |
| `offset` | integer | Nie | 0 | Przesunięcie stronicowania |
| `ordering` | string | Nie | `rank` | Obsługuje wyłącznie sortowanie według `rank`; prefiks `-` oznacza kolejność malejącą |

Obecny interfejs listy nie obsługuje filtrowania `alias` ani `parent_id`. Gdy alias jest znany, wywołaj bezpośrednio [szczegóły dokumentu](https://platform.acedata.cloud/documents/platform-document-detail); podczas budowania nawigacji drzewiastej po pobraniu stron użyj `parent.id` każdego elementu do grupowania po stronie klienta.

## Przykład żądania

```shell theme={null}
curl --get 'https://platform.acedata.cloud/api/v1/documents/' \
  --data-urlencode 'tag=development' \
  --data-urlencode 'limit=100' \
  --data-urlencode 'ordering=rank' \
  -H 'Accept: application/json'
```

```python theme={null}
import requests

response = requests.get(
    "https://platform.acedata.cloud/api/v1/documents/",
    params={"tag": "development", "limit": 100, "offset": 0},
    timeout=30,
)
response.raise_for_status()
data = response.json()
for document in data["items"]:
    parent = document.get("parent") or {}
    print(document["alias"], parent.get("alias"))
```

## Struktura odpowiedzi

```json theme={null}
{
  "count": 1,
  "items": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "alias": "platform-token",
      "name": "Document of Platform Token",
      "title": "管理 AceDataCloud 平台账户令牌（Account Token）",
      "content": "# 管理 AceDataCloud 平台账户令牌……",
      "type": "Text",
      "private": false,
      "primary_only": false,
      "rank": 2400,
      "tags": [
        "development"
      ],
      "parent": {
        "id": "00000000-0000-4000-8000-000000000002",
        "alias": "platform",
        "title": "AceDataCloud 平台"
      },
      "sibling": null,
      "api_id": null,
      "proxy_id": null,
      "api_method": null,
      "metadata": null,
      "created_at": "2026-01-01T00:00:00Z",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ]
}
```

Lista używa `DocumentIndexSerializer` i obecnie zwraca pola modelu oraz zagnieżdżone relacje; powiązane dokumenty API mogą również zawierać `api_method`. Pola mogą być dodawane w sposób zgodny wstecznie, a klient powinien odczytywać je w razie potrzeby. Gdy potrzebne są `children`, przeanalizowany język treści i hash treści, użyj interfejsu szczegółów.

W przypadku publicznych rekordów powiązanych z dokumentami źródłowymi, `content_source` dostarcza identyfikator dokumentu źródłowego, hash treści źródłowej, żądany język, czas aktualizacji tłumaczenia oraz status `ready`, `stale`, `missing`, `missing_source` lub `ambiguous`; dla pozostałych rekordów to pole ma wartość `null`. `content_hash` przy statusie `ready` odpowiada tłumaczeniu w tym języku. Treść główna jest nadal wyświetlana według pierwotnych zasad, w tym z powrotem do innego języka w przypadku braku tłumaczenia; klienci, którzy muszą synchronizować dokumenty, powinni jednocześnie sprawdzać status i hash, a nie oceniać aktualizacji wyłącznie na podstawie niepustej treści głównej.

## Zalecenia dotyczące użycia

* Odpowiedź zawiera treść główną; podczas synchronizacji zbiorczej używaj stronicowania i ustaw rozsądny limit czasu, nie pobieraj współbieżnie tej samej strony.
* Alias jest stabilnym identyfikatorem URL publicznej strony; gdy alias jest znany, zażądaj bezpośrednio `/api/v1/documents/{alias}`.
* Obecny interfejs nie może filtrować po stronie serwera według elementu nadrzędnego; podczas budowania nawigacji grupuj po stronie klienta według `parent.id`.

## Powiązane interfejsy API

* [Pobieranie szczegółów dokumentu platformy AceDataCloud](https://platform.acedata.cloud/documents/platform-document-detail)
* [Pobieranie szczegółów API platformy AceDataCloud](https://platform.acedata.cloud/documents/platform-api-detail)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.