ОРВМ

  1. Главная
  2. ОРВМ

Документация по API ОРВМ


Ниже опубликована по API, для взаимодействия между информационными системами ОРВМ и вашим приложениями. Для работы с API вам потребуется получить ключи [key] на сайте https://orvm.info


Существуют 2 ключа, с разным уровнем доступа, срок действия каджого ключа 1 год:

  • [user-key] - ключ для работы с информацией, которая доступна пользователям: календарь бреветов, информация о своём или доверенном профиле, рейтинг и т.д. Ключ можно получить в профиле пользователя
  • [club-key] - ключ для работы с информацией, которая доступна клубам (организаторам бреветов): редактирование информации по бреветам, протоколам, участиникам, клубу и т.д. Ключ можно получить в профиле клуба

С помощью полученного ключа не обходимо произвести регистрацию и получению [token], кажды ключ может получить несколько токенов, которые действуют 6 часов и далее использую [refresh] получаете новый токен



Авторизация

Для получения [token_user|club] доступа

POST
/api/v1/authorize/

Запрос:

curl -X POST https://orvm.info/api/v1/authorize/ -d api_key=[key_user|club] -d description="Test Service"
api_key
uuid
Ключ API доступа
description
text
Краткое описание, где будет использоваться

Ответ сервера:

return
string
Ответ при выполнении запроса: error или good
token
uuid
[token] - токен доступа
date_expired
DateTime
Срок действия
expired
integer
Срок действия
refresh
uuid
[refresh] - токен обновления

Обновлено: 16.02.2026 09:07

Проверка токена

Проверка [token_user|club] срок действия

POST
/api/v1/check/

Запрос:

curl -X POST https://orvm.info/api/v1/check/ -d token=[token_user|club]
token
uuid
[token] для проверка

Ответ сервера:

return
string(25)
Ответ при выполнении запроса: error или good
token
uuid
[token] - токен доступа
date_expired
DateTime
Срок действия
expired
integer
Срок действия

Обновлено: 16.02.2026 09:14

Обновление токена

Обновление токена, который истёк или истекает

POST
/api/v1/refresh/

Запрос:

curl -X POST https://orvm.info/api/v1/refresh/ -d refresh=[token_user|club]
refresh
uuid
[refresh] токена который хотите обновить

Ответ сервера:

return
string
Ответ при выполнении запроса: error или good
token
uuid
[token] - токен доступа
date_expired
DateTime
Срок действия
expired
integer
Срок действия
refresh
uuid
[refresh] - токен обновления

Обновлено: 16.02.2026 09:14

Список бреветов

По умолчанию будет выдан список бреветов текущего сезона

POST
/api/v1/brevet/

Запрос:

curl -X POST https://orvm.info/api/v1/brevet/ -H "Authorization: Bearer [token_user]" -H "Content-Type: x-www-form-urlencoded"
token
uuid
[token] доступа, пользовательский

Ответ сервера:

id
integer
ID бревета
date
DateTime
Дата и время старта
name
String
Название бревета
distance
float
Дистанция (км)
height
float
Набор высоты (м)
status
integer
Код статуса: Запланирован - 1, Регистрация - 2, Проходит - 3, Завершён - 4, Отменён - 5
club_id
integer
ID клуба
route
uuid
Индификатор маршрута
brevet_type
string
Тип бревета (строка)
reg_url
string
Ссылка на регистрацию

Обновлено: 16.02.2026 09:14

Список клубов ОРВМ

Получение списка клубов с их информацией

POST
/api/v1/club/

Запрос:

curl -X GET https://orvm.info/api/v1/club/ -H "Authorization: Bearer [token_user]"
token
uuid
[token] доступа, пользовательский

Ответ сервера:

id
integer
ID клуба
name_rus
string
Название клуба
name_lat
string
Название клуба
cod_acp
string
Код клуба ACP

Обновлено: 16.02.2026 09:15

Информация по маршруту

Выводится информация по маршруту

POST
/api/v1/route/

Запрос:

curl -X POST https://orvm.info/api/v1/route/ -H "Authorization: Bearer [token_user]" -H "Content-Type: x-www-form-urlencoded" -d uuid=dca852d9-c853-4121-b3fa-0c9766922897
uuid
uuid
Идентификатор маршрута

Ответ сервера:

info.name
string
Название маршрута
info.track_gpx
string
Файл трека в формате gpx
info.start_lat
float
Координаты старта (широта)
info.start_lon
float
Координаты старта (долгота)
info.finish_lat
float
Координаты финиша (широта)
info.finish_lon
float
Координаты финиша (долгота)
info.distance
float
Длина дистанции (м)
info.elevation
float
Набор высоты (м)
info.brevet_type
integer
Тип бревета: 1 - BRM 200, 2 - BRM 300, 3 - BRM 400, 4 - BRM 600, 5 - LRM 1200+, 6 - Flesh, 7 - BRM 1000, 8 - Клубная сотка

Обновлено: 29.03.2026 14:14

Создание марафона в базе ОРВМ

Добавление нового марафона от клуба

POST
/api/v1/club-brevet/

Запрос:

curl -X POST https://orvm.info/api/v1/club-brevet/ -H "Authorization: Bearer [token_club]" -d type=add -d name="Путь отчаянных" date_start="2026-08-04 08:00"
token
uuid
[token] доступа, клубный
type
string
Тип операции: add - создание бревета
name
string
Название бревета
date_start
datetime
Время старта

Ответ сервера:

id
integer
Номер бревета в базе ОРВМ
date_start
datetime
Время старта

Обновлено: 29.03.2026 14:25

Информация о марафоне из базы ОРВМ

Описание

POST
/api/v1/club-brevet/

Запрос:

curl -X POST https://orvm.info/api/v1/club-brevet/ -H "Authorization: Bearer [token_club]" -d type=info -d id="456"
type
string
Тип операции: info - получить информацию о бревете из базы данных ОРВМ
id
integer
Id бревета в базе ОРВМ

Ответ сервера:

id
integer
Id бревета в базе ОРВМ
date_start
datetime
Время старта

Обновлено: 29.03.2026 14:24

Список марафонов в базе ОРВМ

Для вывода списка марафонов клуба

POST
/api/v1/club-brevet/

Запрос:

curl -X POST https://orvm.info/api/v1/club-brevet/ -H "Authorization: Bearer [token_club]" -d type=list -d year=2025
type
string
Тип операции: list - получить информацию о всех бреветах клуба из базы данных ОРВМ
year
integer
Год за который будет выведен список

Ответ сервера:

id
integer
ID марафона в базе ОРВМ
date
datetime
Дата и время марафона
name
string
Название бревета в базе ОРВМ

Обновлено: 29.03.2026 14:38

Редактирование марафона в базе ОРВМ

Редактирование информации о марафоне в базе ОРВМ

POST
/api/v1/club-brevet/

Запрос:

curl -X POST https://orvm.info/api/v1/club-brevet/ -H "Authorization: Bearer [token_club]" -d type=edit -d id="456" -d name="В поисках завтрака"
type
string
Операция: edit - редактирование
id
integer
Id номер бревета в базе ОРВМ
name
string
Название бревета

Ответ сервера:

id
integer
Id номер бревета в системе ОРВМ

Обновлено: 29.03.2026 14:24

Создание протокола в базе ОРВМ

Создание нового протокола к марафону, есть протокол или нет, в ответ будет отправлен его ID

POST
/api/v1/club-protokol/

Запрос:

curl -X POST https://orvm.info/api/v1/club-protokol/ -H "Authorization: Bearer [token_club]" -d type=create -d id=2412
type
string
create - создаём новый протокол
id
integer
ID марафона

Ответ сервера:

id
integer
ID - номер протокола в система ОРВМ
date
datetime
Дата создание протокола, тут можно определить, новый протокол или протокол у марафона уже есть

Обновлено: 29.03.2026 14:37

Добавление пунктов в протокол

Добавление пунктов в протокол (внесение информации по участникам)

POST
/api/v1/club-protokol/

Запрос:

curl -X POST https://orvm.info/api/v1/club-protokol/ -H "Authorization: Bearer [token_club]" -d type=add -d id="456" -d iuc="TR5336" -d name_rus="Иван" -d surname_rus="Иванов" -d name_lat="Ivan" -d surname_lat="Ivanov" -d time="2341" -d medal="true" -d woman="false"
type
string
Тип операции
id
integer
ID индификатор протокола
iuc
string
Уникальный короткий код пользователя в базе ОРВМ, если он указан, то информация по участнику берётся из базы ОРВМ
name_rus
string
Имя участника на кириллице
surname_rus
string
Фамилия участника на кириллице
name_lat
string
Имя участника на латинице (как в заграничном паспорте)
surname_lat
string
Фамилия участника на латинице (как в заграничном паспорте)
time
integer
Время прохождения дистанции в минутах, например 7 часов 43 минуты = 463
medal
integer
Заказ медали (0 или 1)
woman
integer
Женский пол (0 или 1)

Ответ сервера:

id
integer
ID регистрации (омолгации) в базе ОРВМ

Обновлено: 30.03.2026 05:32

Получение информации по протоколу

Получение списка позиций из протокола марафона

POST
/api/v1/club-protokol/

Запрос:

curl -X POST https://orvm.info/api/v1/club-protokol/ -H "Authorization: Bearer [token_club]" -d type=list -d id="456"

Ответ сервера:

Обновлено: 30.03.2026 05:33

Запрос информации по участнику

Используется для получение информации по пользователю, который предоставил уникальный короткий код пользователя.

POST
/api/v1/club-user/

Запрос:

curl -X POST https://orvm.info/api/v1/club-user/ -H "Authorization: Bearer [token_club]" -d id="RW3867"

Ответ сервера:

Обновлено: 30.03.2026 07:10