Для повышения удобства технического взаимодействия клиентов и партнёров транспортной компании MagicTrans был реализован простой и доступный программный интерфейс — MagicTrans.API, работающий поверх протокола HTTP.
Данное руководство описывает интерфейс доступа к MagicTrans API, и предназначено для программистов, автоматизирующих взаимодействие с нашей транспортной компанией MagicTrans.
Предполагается, что специалист знаком с основами HTTP и имеет навыки программирования.
- В MagicTrans.API первоначальный refresh token запрашивается через обращение в поддержку (через рабочий чат или по почте api@magic-trans.ru).
- В дальнейшем токен необходимо обновлять самостоятельно до истечения его срока действия.
Внимание: Ни одна функция с удаленным токеном работать не будет.
- Лимитирование количества запросов происходит на каждый отдельный token, а не на аккаунт token`a.
- Лимитирование разделяется по методам MagicTrans.API . Например: если Ваше приложение истратило лимит используя метод PUT /v1/order то блокировка метода GET /v1/track по лимиту не происходит. У каждого метода свой лимит для token.
- В случае превышения лимита будет возвращен статус страницы 429, а так же ответ формата {"name":"Too Many Requests","message":"Rate limit exceeded.","code":0,"status":429}.
- MagicTrans.API выведено на отдельный поддомен https://api.magic-trans.ru
- Каждый метод имеет вид /prc/hs/SecurityAPI или /prc/hs/EcommAPI
Таким образом URL для данного метода будет выглядеть следующим образом:
https://api.magic-trans.ru/prc/hs/SecurityAPI