Перейти к основному содержанию

Documentation Index

Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt

Use this file to discover all available pages before exploring further.

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

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

API v2 вводит версионированную структуру URL, новые группы эндпоинтов и опциональный поток аутентификации Bearer-токеном параллельно с API-ключом.
Areav1v2
Base path/customer/v1//customer/v2/
Auth — API keyX-ORBIT-KEY: <key> headerSame — unchanged
Auth — Bearer tokenNot supportedAuthorization: Bearer <token>
License endpoints/customer/v1/licenses/.../customer/v2/licenses/...
IP whitelistingFlat endpointsNested under /licenses/{id}/ips
API key managementNot available/customer/v2/api-keys/...
ProfileNot available/customer/v2/profile/...
InvoicesNot 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 Endpointv2 Equivalent
GET /customer/v1/licensesGET /customer/v2/licenses
GET /customer/v1/licenses/{id}GET /customer/v2/licenses/{id}
POST /customer/v1/licenses/{id}/reset-keyPOST /customer/v2/licenses/{id}/reset-key
POST /customer/v1/licenses/{id}/regenerate-keyPOST /customer/v2/licenses/{id}/regenerate-key
GET /customer/v1/locationsGET /customer/v2/licenses/locations
GET /customer/v1/licenses/{id}/ipsGET /customer/v2/licenses/{id}/ips
POST /customer/v1/licenses/{id}/ipsPOST /customer/v2/licenses/{id}/ips
DELETE /customer/v1/licenses/{id}/ips/{ip}DELETE /customer/v2/licenses/{id}/ips/{ip}

​
Только в v2

Эти эндпоинты отсутствуют в v1 и доступны только в v2:
EndpointDescription
POST /customer/v2/auth/device/codeInitiate device authorization flow
POST /customer/v2/auth/device/tokenExchange device code for access token
POST /customer/v2/auth/wallet/challengeRequest wallet signature challenge
POST /customer/v2/auth/wallet/verifyVerify wallet signature and get token
GET /customer/v2/api-keysList all API keys
POST /customer/v2/api-keysCreate 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/profileGet user profile
PATCH /customer/v2/profileUpdate user profile
GET /customer/v2/profile/balanceGet account balance
GET /customer/v2/invoicesList invoices
GET /customer/v2/invoices/{id}Get a specific invoice
POST /customer/v2/invoices/{id}/payPay invoice with account balance

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

1

Обновите базовый 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
2

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

Эндпоинт locations перенесён с верхнего уровня в группу licenses:
# Before
GET /customer/v1/locations

# After
GET /customer/v2/licenses/locations
3

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

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

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

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

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

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