начало работы

Быстрый старт

От регистрации до первого успешного ответа через шлюз Hexly — пять шагов, около пяти минут.

1. Создайте аккаунт и проект

Зарегистрируйтесь на hexly.dev/signup — подтверждение по email не требуется для начала работы на плане Free. После входа создайте первый проект: он станет изолированным пространством со своими ключами и маршрутами.

2. Получите API-ключ

В разделе Настройки проекта → API-ключи создайте новый ключ с областью действия gateway:read и gateway:write. Сохраните его — полный ключ показывается только один раз.

!

Никогда не встраивайте боевой API-ключ в клиентский код мобильного приложения или фронтенда — используйте его только на сервере. Для клиентских сценариев применяйте краткоживущие токены через OAuth.

3. Установите SDK

терминал
# npm
npm install @hexly/sdk

# pip
pip install hexly-sdk

4. Опишите первый маршрут

Создайте файл hexly.config.yaml в корне проекта и укажите маршрут, который должен обрабатывать шлюз:

hexly.config.yaml
project: my-app
routes:
  - path: /v1/hello
    upstream: https://api.myapp.dev/hello

Загрузите конфигурацию через CLI: hexly deploy — маршрут станет доступен в течение нескольких секунд.

5. Отправьте первый запрос

терминал
curl https://gw.hexly.dev/v1/hello \
  -H "Authorization: Bearer hx_live_..."

# → 200 OK
# { "message": "Hello from your upstream service" }

Готово — запрос прошёл через шлюз Hexly, был засчитан в лимит вашего тарифа и отразился в дашборде метрик в реальном времени.

Что дальше