Endpointy API
Ścieżka bazowa: /api/v1
O ile nie napisano inaczej, wyślij Authorization: Bearer nd_....
Projekty
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /api/v1/projects | Lista projektów |
| POST | /api/v1/projects | Utwórz projekt |
| GET | /api/v1/projects/:id | Pobierz projekt |
| PATCH | /api/v1/projects/:id | Zaktualizuj projekt |
| DELETE | /api/v1/projects/:id | Usuń projekt |
Artykuły
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /api/v1/articles?projectId= | Lista artykułów |
| POST | /api/v1/articles | Utwórz artykuł |
| GET | /api/v1/articles/:id | Pobierz artykuł |
| PATCH | /api/v1/articles/:id | Zaktualizuj artykuł |
| DELETE | /api/v1/articles/:id | Usuń artykuł |
Przykład tworzenia:
bash
curl -X POST https://your-domain.com/api/v1/articles \
-H "Authorization: Bearer nd_your_key" \
-H "Content-Type: application/json" \
-d "{\"projectId\":\"PROJECT_ID\",\"title\":\"Hello\",\"contentMarkdown\":"# Hello\\n\\nWorld\" }"Kategorie
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /api/v1/categories?projectId= | Lista kategorii |
| POST | /api/v1/categories | Utwórz kategorię |
Media
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /api/v1/media?projectId= | Lista plików mediów |
Wyszukiwanie
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /api/v1/search?q=&projectId= | Szukaj artykułów |
Webhooki
| Metoda | Ścieżka | Opis |
|---|---|---|
| POST | /api/v1/webhooks/test | Wyślij testowe delivery |
Body: { "webhookId": "..." }
Import / eksport / narzędzia
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /api/export/markdown?projectId= | ZIP Markdown |
| GET | /api/export/json?projectId= | Dump JSON |
| POST | /api/import/markdown | Import Markdown |
| POST | /api/sync/github | Sync z GitHub |
| POST | /api/broken-links/scan | Skan martwych linków |
Pełna tabela z notatkami: otwórz /api-docs na swojej instalacji.