Миграция с v1 на v2

API v1 устарел. Он пока работает, но будет удалён в будущей версии. Переходите на v2, чтобы получить полный набор эндпоинтов, улучшенную аутентификацию, управление профилем и операции со счетами.

Что изменилось

API v2 вводит версионированную структуру URL, новые группы эндпоинтов и опциональный поток аутентификации Bearer-токеном параллельно с API-ключом.

Area	v1	v2
Base path	`/customer/v1/`	`/customer/v2/`
Auth — API key	`X-ORBIT-KEY: <key>` header	Same — unchanged
Auth — Bearer token	Not supported	`Authorization: Bearer <token>`
License endpoints	`/customer/v1/licenses/...`	`/customer/v2/licenses/...`
IP whitelisting	Flat endpoints	Nested under `/licenses/{id}/ips`
API key management	Not available	`/customer/v2/api-keys/...`
Profile	Not available	`/customer/v2/profile/...`
Invoices	Not available	`/customer/v2/invoices/...`

Аутентификация — менять ничего не нужно

Если вы аутентифицируетесь заголовком X-ORBIT-KEY, для auth ничего менять не нужно. Тот же ключ работает с v2.

# Works with both v1 and v2
curl -H "X-ORBIT-KEY: YOUR_API_KEY" https://api.orbitflare.com/customer/v2/licenses

При желании можно перейти на Bearer-токен (device flow или подпись кошелька). Подробнее в эндпоинтах Auth.

Сопоставление эндпоинтов

Licenses

v1 Endpoint	v2 Equivalent
`GET /customer/v1/licenses`	`GET /customer/v2/licenses`
`GET /customer/v1/licenses/{id}`	`GET /customer/v2/licenses/{id}`
`POST /customer/v1/licenses/{id}/reset-key`	`POST /customer/v2/licenses/{id}/reset-key`
`POST /customer/v1/licenses/{id}/regenerate-key`	`POST /customer/v2/licenses/{id}/regenerate-key`
`GET /customer/v1/locations`	`GET /customer/v2/licenses/locations`
`GET /customer/v1/licenses/{id}/ips`	`GET /customer/v2/licenses/{id}/ips`
`POST /customer/v1/licenses/{id}/ips`	`POST /customer/v2/licenses/{id}/ips`
`DELETE /customer/v1/licenses/{id}/ips/{ip}`	`DELETE /customer/v2/licenses/{id}/ips/{ip}`

Только в v2

Эти эндпоинты отсутствуют в v1 и доступны только в v2:

Endpoint	Description
`POST /customer/v2/auth/device/code`	Initiate device authorization flow
`POST /customer/v2/auth/device/token`	Exchange device code for access token
`POST /customer/v2/auth/wallet/challenge`	Request wallet signature challenge
`POST /customer/v2/auth/wallet/verify`	Verify wallet signature and get token
`GET /customer/v2/api-keys`	List all API keys
`POST /customer/v2/api-keys`	Create a new API key
`PATCH /customer/v2/api-keys/{id}`	Update an API key
`DELETE /customer/v2/api-keys/{id}`	Delete an API key
`GET /customer/v2/profile`	Get user profile
`PATCH /customer/v2/profile`	Update user profile
`GET /customer/v2/profile/balance`	Get account balance
`GET /customer/v2/invoices`	List invoices
`GET /customer/v2/invoices/{id}`	Get a specific invoice
`POST /customer/v2/invoices/{id}/pay`	Pay invoice with account balance

Шаги миграции

Обновите базовый URL

Смените префикс пути клиента с /customer/v1/ на /customer/v2/:

# Before
curl -H "X-ORBIT-KEY: YOUR_API_KEY" \
  https://api.orbitflare.com/customer/v1/licenses

# After
curl -H "X-ORBIT-KEY: YOUR_API_KEY" \
  https://api.orbitflare.com/customer/v2/licenses

Обновите эндпоинт locations

Эндпоинт locations перенесён с верхнего уровня в группу licenses:

# Before
GET /customer/v1/locations

# After
GET /customer/v2/licenses/locations

Протестируйте интеграцию

Прогоните существующую интеграцию против эндпоинтов v2. Формы ответов для общих эндпоинтов (licenses, IPs) обратно совместимы. Для перенесённых эндпоинтов менять разбор ответов не должно понадобиться.

(Опционально) Улучшите аутентификацию

Если нужен Bearer-токен вместо API-ключей, реализуйте device authorization flow или wallet signature flow.

Нужна помощь?

По вопросам миграции пишите в Discord или на support@orbitflare.com.

Обзор

Customer API v2

Customer API v1 (устаревший)

Миграция с v1 на v2

Что изменилось

Аутентификация — менять ничего не нужно

Сопоставление эндпоинтов

Licenses

Только в v2

Шаги миграции

Нужна помощь?

​Что изменилось

​Аутентификация — менять ничего не нужно

​Сопоставление эндпоинтов

​Licenses

​Только в v2

​Шаги миграции

​Нужна помощь?

Что изменилось

Аутентификация — менять ничего не нужно

Сопоставление эндпоинтов

Licenses

Только в v2

Шаги миграции

Нужна помощь?