docs: API reference — old deck-api + new lk-api-gateway

2026-07-01 20:21:32 +04:00
parent f094b45d33
commit 76f0b82c96
1 changed files with 53 additions and 0 deletions
@@ -0,0 +1,53 @@
+# Nubes API Reference
+
+## Старый API (deck-api) — работает, проверено 2026-07-01
+
+Формат: `?endpoint=/instances&page=1&size=...`
+
+| Стенд | URL |
+|---|---|
+| DEV | `https://deck-api-dev.ngcloud.ru/api/v1/index.cfm` |
+| TEST | `https://deck-api-test.ngcloud.ru/api/v1/index.cfm` |
+| PROD | `https://deck-api.ngcloud.ru/api/v1/index.cfm` |
+
+## Новый API Gateway (lk-api-gateway) — работает, проверено 2026-07-01
+
+Формат: REST-пути (`/instances` вместо `?endpoint=/instances`)
+
+| Стенд | URL |
+|---|---|
+| DEV | `https://lk-api-gateway-dev.ngcloud.ru/api/v1/svc` |
+| TEST | `https://lk-api-gateway-test.ngcloud.ru/api/v1/svc` |
+| PROD | `https://lk-api-gateway.ngcloud.ru/api/v1/svc` |
+
+## Проверенные эндпоинты нового gateway
+
+```
+GET  /api/v1/svc
+GET  /api/v1/svc/instances?page=1&size=...
+GET  /api/v1/svc/instances/{instanceUid}   (предположительно)
+POST /api/v1/svc/instances                  (предположительно)
+```
+
+Данные возвращаются те же, что и в старом API (JSON идентичен).
+
+## Токены
+
+| Стенд | Файл | Формат |
+|---|---|---|
+| DEV | `secrets/dev.token` | JWT, ~1387 байт |
+| TEST | `secrets/test.token` | JWT, ~1387 байт |
+| PROD | `secrets/prod.token` | JWT, ~1387 байт |
+
+## Важно
+
+- Новый gateway **не поддерживает** `?endpoint=` — только REST-пути
+- Старый `index.cfm` с `?endpoint=` — работает, используется провайдером v5.0.75
+- Переход на новый gateway потребует переделки URL-роутинга в провайдере
+- `.deck.nubes.ru` домены **не работают** — только `.ngcloud.ru`
+
+## DNS
+
+| Хост | IP |
+|---|---|
+| `*.ngcloud.ru` (все API) | `185.178.210.252` |