Документация API

Программный доступ к аналитике Glypha.

Интегрируйте мощь структурной визуализации Glypha в ваши внутренние продукты. RESTful API с поддержкой GraphQL, строгими типами данных и полной документацией для разработчиков.

Скриншот кода API запроса и JSON ответа Glypha
---

Auth: Методы авторизации

Безопасность — фундамент взаимодействия с платформой. Все запросы к Glypha API должны быть аутентифицированы через HTTP-заголовки.

Key

API Keys

Используйте статические ключи для серверных интеграций. Ключи генерируются в панели администратора и имеют права чтения (Read-only) или полного доступа (Admin). Передавайте в заголовке: Authorization: Bearer YOUR_API_KEY.

Oauth

OAuth 2.0

Для клиентских приложений (SPA) используйте протокол OAuth 2.0 (PKCE flow). Это обеспечивает временные токены доступа, которые автоматически инвалидируются через 24 часа, минимизируя риски утечки данных.

Пример запроса

POST /api/v1/auth/token
Content-Type: application/json

{
  "grant_type": "client_credentials",
  "client_id": "glypha_enterprise_01",
  "client_secret": "sk_live_..."
}
---

Endpoints: Список доступных эндпоинтов

Единая точка входа для извлечения графов, метрик и сырых данных.

GET

/graphs/structure

Возвращает иерархическое дерево корпоративной структуры в формате JSON. Поддерживает параметры фильтрации по дивизионам и датам изменения.

/api/v1/graphs/structure?depth=3
GET

/analytics/metrics

Доступ к агрегированным показателям эффективности. Включает данные по выручке, оптимизации затрат и кадровым перемещениям за выбранный период.

/api/v1/analytics/metrics?range=Q3-2023
POST

/ingest/batch

Массовая загрузка внешних данных для пересчета паттернов. Принимает ZIP-архивы с CSV/Excel файлами и автоматически запускает процесс валидации.

/api/v1/ingest/batch
GET

/reports/export

Генерация отчетов в форматах PDF или SVG для прямой вставки в презентационные материалы. Поддерживает кастомизацию цветовых схем.

/api/v1/reports/export?id=rep_8821
---
Rate Limits

Ограничения запросов

Мы гарантируем стабильность сервиса для всех клиентов через строгую политику квотирования.

Базовый план 1,000 запросов / час
Business план 10,000 запросов / час
Enterprise Безлимитно (по договоренности)

Обработка ошибок

При превышении лимита API возвращает статус 429 Too Many Requests.

Заголовок Retry-After указывает время в секундах до следующей попытки.