Shtrafovnet API

https://api.shtrafovnet.ru/latest/dealers/

Мы предоставляем услуги по массовой проверке штрафов ГИБДД для клиентов дилера/интегратора с выставлением отдельных счетов на обслуживание по каждому клиенту с получением партнерских вознаграждений

Подробнее об условиях: https://dealers.shtrafovnet.ru/

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

Запросы

Любой инструмент, умеющий работать с HTTP, может связываться с API просто путем формирования правильного URI. Запросы должны выполняться с использованием протокола HTTPS, чтобы трафик шифровался. Интерфейс реагирует на различные методы в зависимости от требуемого действия.

Мы используем кодировку UTF-8. Все данные необходимо передавать в формате JSON. Формат ответа, нами так же отправляется в формате JSON.

Метод Описание
GET

Для простого извлечения информации о вашей учетной записи, транспортных средствах или информации о штрафах вам следует использовать метод GET. Запрошенная вами информация будет возвращена вам как объект JSON.

Атрибуты, определенные объектом JSON, могут использоваться для формирования дополнительных запросов. Любой запрос с использованием метода GET доступен только для чтения и не влияет на какие-либо объекты, которые вы запрашиваете.

DELETE

Чтобы уничтожить ресурс и удалить его из учетной записи, следует использовать метод DELETE. Это удалит указанный объект, если он будет найден. Если он не найден, операция вернет ответ, указывающий, что объект не найден.

Эта идемпотентность означает, что вам не нужно проверять наличие ресурсов до вызова команды удаления, конечное состояние будет таким же, независимо от его существования.

PUT

Для обновления информации о ресурсе в вашей учетной записи доступен метод PUT (должны быть переданы все данные объекта).

Как и метод DELETE, метод PUT является идемпотентом. Он устанавливает состояние цели, используя предоставленные значения, независимо от их текущих значений. Запросы, используя метод PUT, не нужно проверять текущие атрибуты объекта.

POST

Чтобы создать новый объект, в вашем запросе должен быть указан метод POST.

Запрос POST включает в себя все атрибуты, необходимые для создания нового объекта. Если вы хотите создать новый объект, отправьте POST запрос на целевой URI.

PATCH

Для обновления информации о ресурсе в вашей учетной записи доступен метод PATCH (необходимо передать только изменяемые поля).

Отличие от метода PUT в том, что данный метод не изменяет полностью объект, а только пеерданные параметры.

Ответы

Когда запрос выполнен успешно, тело ответа обычно отправляется обратно в виде объекта JSON. Исключением является обработка запроса DELETE, который приведет к успешному состоянию HTTP 204 и пустому телу ответа.

RESPONSE FOR AN OBJECT COLLECTION
{
  "cars": [
    {
      "id": 123
      "cert": "11AA123456"
      . . .
    },
    {
      "id": 234
      "cert": "11BB123456"
      . . .
    }
  ]
}
RESPONSE FOR A SINGLE OBJECT
{
  "id": 123
  "cert": "11AA123456"
  . . .
}

Параметры

Существует два разных способа передачи параметров в запросе с помощью API.

При передаче параметров для создания или обновления объекта параметры должны передаваться как объект JSON, содержащий имена и значения соответствующих атрибутов в виде пар «ключ-значение». Когда вы используете этот формат, вы должны указать, что вы отправляете объект JSON в заголовок. Это делается путем установки заголовка Content-Type: application/json. Это гарантирует, что ваш запрос будет интерпретирован правильно.

При передаче параметров для фильтрации ответа на запросы GET параметры могут передаваться с использованием стандартных атрибутов запроса. В этом случае параметры будут встроены в URI, добавив ? в конце URI, а затем установки каждого атрибута с помощью знака равенства. Атрибуты могут быть разделены символом &.

PASS PARAMETERS AS A JSON OBJECT
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"cert": "11AA123456", "reg": "а001аа777"}' \
     -X POST "https://api.shtrafovnet.ru/v2/cars"
PASS FILTER PARAMETERS AS A QUERY STRING
curl -H "Authorization: Bearer $TOKEN" \
        -X GET "https://api.shtrafovnet.ru/v2/cars/1234/fines?type=nopaid"

Авторизация

Для методов управления аккаунтом , а так же для получения токена доступа используется Basic-авторизация.

Для всех остальных запросов необходимо указывать заголовок Authorization: Bearer $TOKEN содержащий полученный токен доступа.

CURL EXAMPLE (BASIC AUTH)
curl -X $HTTP_METHOD -H 'Content-Type: application/json' \
     -u '$EMAIL:$PASSWORD' \
     $URL 
CURL EXAMPLE (BEARER AUTH)
curl -X $HTTP_METHOD \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer $TOKEN' \
     $URL 

Библиотеки

Чтобы максимально упростить интеграцию Shtrafovnet API, существуют официальные клиенты:

Ошибки

Если возникает ошибка, будь то на сервере или на стороне клиента, сообщения об ошибках будут возвращены в массиве ошибок.

Например:

400 Bad Request
{
    "status":400,
    "type":"validation_error",
    "title":"There was a validation error",
    "errors":{
        "name":[
            "This value should not be blank."
        ],
        "email":[
            "Email address can not be empty",
            "This value should not be blank."
        ],
        "companyInn":[
            "This value should not be blank."
        ],
        "plainPassword":[
            "This value should not be blank."
        ]
    }
}

Ссылки

Объект ссылки возвращается как часть тела ответа, когда включена разбивка на страницы.

По умолчанию для каждой страницы возвращается 200 объектов. Если ответ содержит 200 объектов или меньше, объект ссылок не будет возвращен.

Если ответ содержит более 200 объектов, первые 200 будут возвращены вместе с объектом ссылок.

Объект _links содержит содержит ключи, указывающие взаимосвязь дополнительных страниц. Значения этих параметров - это URL-адреса связанных страниц. Ключи будут следующими:

  • self: URI текущей страницы результатов.
  • first: URI первой страницы результатов.
  • prev: URI предыдущей последовательной страницы результатов.
  • next: URI следующей последовательной страницы результатов.
  • last: URI последней страницы результатов.

Параметры:

  • pages указывает на общее количество страниц результата запроса.
  • page указывает на текущую страницу результата запроса.
  • total указывает на общее количество элементов результата запроса.
  • count указывает на количество элементов запроса на текущей странице.
SAMPLE LINKS OBJECT
{
    . . .
    "pages": 10,
    "page": 1,
    "total": 2000,
    "count": 200,
    "_links": {
        "self": "https://api.shtrafovnet.ru/v2/cars?page=1",
        "first": "https://api.shtrafovnet.ru/v2/cars?page=1",
        "next": "https://api.shtrafovnet.ru/v2/cars?page=2",
        "last": "https://api.shtrafovnet.ru/v2/cars?page=3"
    },
    . . .
}

Аккаунт

Информация об аккаунте

Получение сводной информации об аккаунте дилера/интегратора
GET /account
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Идентификатор
Уникальный идентификатор аккаунта
id
INTEGER
---
---
Логин
Имя пользователя
username
STRING
---
---
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
---
---
Статус
Состояние аккаунта
status
STRING
new
---
Имя
first_name
STRING
---
---
Фамилия
last_name
STRING
---
---
Отчество
middle_name
STRING
---
---
Телефон
phone
STRING
---
---
Дата создания
Дата регистрации аккаунта
created_at
DATETIME
---
---
Дата последней активности
Дата последней активности пользователя
last_activity_at
DATETIME
NOW()
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/account'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "777", "username": "User", "email": "user@test.ru", "status": "new", "first_name": "Алексей", "last_name": "Иванов", "middle_name": "Петрович", "phone": "79005551122", "created_at": "2019-01-01 00:00:00", "last_activity_at": "2019-01-01 00:00:00" }

Регистрация нового аккаунта

Создание нового аккаунта дилера/интегратора.
После регистрации на указанную почту будет отправлено письмо с подтверждением.

Дальнейшая работа с API возможна только с подтвержденным аккаунтом.

POST /account/registration
Request headers
Key
Value
Content-Type
application/json
Request parameters
Name
Code
Type
Required?
Allowed values
Сокращенное наименование
name
STRING
Yes
---
Телефон
phone
STRING
Yes
---
ИНН
Идентификационный номер налогоплательщика (ИНН)
inn
STRING
Yes
---
ФИО контактного лица
fullname
STRING
Yes
---
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
Yes
---
Пароль
password
STRING
Yes
---
Response headers
Key
Value
Content-Type
application/json
Location
https://api.shtrafovnet.ru/latest/dealers/account
Response parameters
Name
Code
Type
Default
Allowed values
Идентификатор
Уникальный идентификатор аккаунта
id
INTEGER
---
---
Логин
Имя пользователя
username
STRING
---
---
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
---
---
Статус
Состояние аккаунта
status
STRING
new
---
Имя
first_name
STRING
---
---
Фамилия
last_name
STRING
---
---
Отчество
middle_name
STRING
---
---
Телефон
phone
STRING
---
---
Дата создания
Дата регистрации аккаунта
created_at
DATETIME
---
---
Дата последней активности
Дата последней активности пользователя
last_activity_at
DATETIME
NOW()
---
Curl example:
curl --request POST \ --header 'Content-Type:application/json' \ --data '{"name":"Company Inc","phone":"8 800 2000 500","inn":"1234567890","fullname":"Алексей Петрович Иванов","email":"user@test.ru","password":"my_secret"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/account/registration'
Response example:
HTTP/1.1 201 Created Content-Type:application/json Location:https://api.shtrafovnet.ru/latest/dealers/account { "id": "777", "username": "User", "email": "user@test.ru", "status": "new", "first_name": "Алексей", "last_name": "Иванов", "middle_name": "Петрович", "phone": "79005551122", "created_at": "2019-01-01 00:00:00", "last_activity_at": "2019-01-01 00:00:00" }

Обновление информации аккаунта

Не обязательно передавать все параметры аккаунта, в теле запроса вы можете указать только необходимые
PATCH /account
Request headers
Key
Value
Content-Type
application/json
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
password
password
STRING
No
---
Фамилия
last_name
STRING
No
---
Имя
first_name
STRING
No
---
Отчество
middle_name
STRING
No
---
Телефон
phone
STRING
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Идентификатор
Уникальный идентификатор аккаунта
id
INTEGER
---
---
Логин
Имя пользователя
username
STRING
---
---
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
---
---
Статус
Состояние аккаунта
status
STRING
new
---
Имя
first_name
STRING
---
---
Фамилия
last_name
STRING
---
---
Отчество
middle_name
STRING
---
---
Телефон
phone
STRING
---
---
Дата создания
Дата регистрации аккаунта
created_at
DATETIME
---
---
Дата последней активности
Дата последней активности пользователя
last_activity_at
DATETIME
NOW()
---
Curl example:
curl --request PATCH \ --header 'Content-Type:application/json' \ --header 'Authorization:Bearer $TOKEN' \ --data '{"password":"secret-string","last_name":"Иванов","first_name":"Алексей","middle_name":"Петрович","phone":"79005551122"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/account'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "777", "username": "User", "email": "user@test.ru", "status": "new", "first_name": "Алексей", "last_name": "Иванов", "middle_name": "Петрович", "phone": "79005551122", "created_at": "2019-01-01 00:00:00", "last_activity_at": "2019-01-01 00:00:00" }

Восстановление пароля от аккаунта дилера

После выполнения запроса будет сформирован новый пароль для вашего аккаунта и отправлен на электронный адрес указанный при регистрации
POST /account/reset-password
Request headers
Key
Value
Content-Type
application/json
Request parameters
Name
Code
Type
Required?
Allowed values
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
Yes
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Сообщение
message
STRING
---
---
Curl example:
curl --request POST \ --header 'Content-Type:application/json' \ --data '{"email":"user@test.ru"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/account/reset-password'
Response example:
HTTP/1.1 201 Created Content-Type:application/json { "message": "New password sent to email" }

Повторная отправка сообщения подтверждения

Повторная отправка регистрационного сообщения для подтверждения аккаунта
POST /account/reconfirm
Request headers
Key
Value
Content-Type
application/json
Request parameters
Name
Code
Type
Required?
Allowed values
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
Yes
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Сообщение
message
STRING
---
---
Curl example:
curl --request POST \ --header 'Content-Type:application/json' \ --data '{"email":"user@test.ru"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/account/reconfirm'
Response example:
HTTP/1.1 201 Created Content-Type:application/json { "message": "Registration letter sent to your email" }

Токен

Создание токена

Создание нового токена доступа к ресурсам и услугам сервиса. Токен бессрочный, поэтому нет необходимости запрашивать его перед каждым запросом (положите его в кэш).

Проекту необходимо реализовать автоматическое получения нового токена в случае его невалидности, смены пароля от аккаунта и тд.

POST /tokens
Request headers
Key
Value
Authorization
Basic %base64-encoding of email:password%
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Токен пользователя
Уникальный токен доступа, который должен использоваться в каждом запросе к API
token
STRING
---
---
Curl example:
curl --request POST \ --header 'Authorization:Basic %base64-encoding of email:password%' \ --url 'https://api.shtrafovnet.ru/latest/dealers/tokens'
Response example:
HTTP/1.1 201 Created Content-Type:application/json { "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJpZCI6MTg1LCJpYXQiOiIxNDk3NDI5MTUzIn0.fKTZRbGGAEyn2eQbwgSx2FP4UOsC2XvMMw0dlw9qvfyraW725SyBEXqMCs1T9Gd5QaHrf9UBv-Qj6MJY23hpoUooQxDGrA-nX3c-ucF79hnaiPEBFVt6vvfeA8F4-ssOqs4s8ZWrufwARsw2JEN0i4XsVKo57N3P_Oh6TYOmECyUI22qAs2WQlJ585Rb4XKe_HXrwNVjP3rLyu2DLSYKjXPDvMh5Lt0wGZjI3LI2Zlr_ri1DxM41FM-7FuREv-zIFpzK6J-Scij-aInt2OA5nfjGt1b7KEtXLfjd6hYFO29h4nm_wSYmYbTgcYv5dwNSDHnDzSnx0nIQe5ZXxg_m3HiBke01SWhikA-ZDYORQstnrRJRer0nYK8BCZwl-SrRK0aOvO_wl0CaYDD5nigra6JWcKJVoNCDfvvYncp8ag_U6CoPzy-hIluBKEOrtWJotySeO1r_1NQuR5VDna8sqKRWtmFN9vwLx8cf_z2Y-9_gMmQmetQHdjd1lOwE0rLeuKmeppp8HcDKWlGASZRwivu3NCEtkWRmzxcvvFQEJkbjP6zmOSyVoeQOKc2P3lkJ4ou5XlTnx2U_Ga8nIwQOnJ5fnez2YQQ_60TrDWTawErTc2kf8qirtJdJD5UwY-ALqsWbau9pEXurDP8OwW-7m4blmBb9bVXpKSZkSCMwW4A" }

Клиенты

Управление аккаунтами клиентов

Список клиентов

Получение полного списка клиентов добавленых в ваш аккаунт
GET /clients
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Общее количество клиентов
Общее количество клиентов (по заданным критериям)
total
INTEGER
---
---
Текущее количество клиентов
Текущее количество клиентов в запросе (по заданным критериям)
count
INTEGER
---
---
Пагинация
Объект содержит содержит ключи, указывающие взаимосвязь дополнительных страниц
_links
ARRAY
---
---
Информация о пользователях
Объект содержит информацию о клиентах дилера
clients
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "total": 1, "count": 1, "_links": "https:\/\/api.shtrafovnet.ru\/latest\/dealers\/clients?page=1", "clients": { "id": "777", "username": "User", "email": "user@test.ru", "status": "new", "first_name": "Алексей", "last_name": "Иванов", "middle_name": "Петрович", "phone": "79005551122", "created_at": "2019-01-01 00:00:00", "fcm_token": "secret-string", "last_activity_at": "2019-01-01 00:00:00" } }

Информация о клиенте

Получение сводной информации о клиенте
GET /clients/:email
Path parameters
Code
Описание
email
Электронная почта клиента
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Идентификатор
Уникальный идентификатор аккаунта
id
INTEGER
---
---
Логин
Имя пользователя
username
STRING
---
---
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
---
---
Статус
Состояние аккаунта
status
STRING
new
---
Имя
first_name
STRING
---
---
Фамилия
last_name
STRING
---
---
Отчество
middle_name
STRING
---
---
Телефон
phone
STRING
---
---
Дата создания
Дата регистрации аккаунта
created_at
DATETIME
---
---
Дата последней активности
Дата последней активности пользователя
last_activity_at
DATETIME
NOW()
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "777", "username": "User", "email": "user@test.ru", "status": "new", "first_name": "Алексей", "last_name": "Иванов", "middle_name": "Петрович", "phone": "79005551122", "created_at": "2019-01-01 00:00:00", "last_activity_at": "2019-01-01 00:00:00" }

Регистрация нового клиента

Регистрация нового клиента

После создания, клиенту будет доступно недельное тестовое информационное обслуживание (проверка штрафов) для ознакомления с работой сервиса.

При положительном решении о дальнейшем сотрудничестве, необходимо будет выставить счет на обслуживание для данного клиента (выбрав необходимый тариф) и оплатить его.

POST /clients
Request headers
Key
Value
Content-Type
application/json
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
Yes
---
Наименование компании
display_name
STRING
No
---
Полное название компании
Полное название компании без сокращений
name
STRING
No
---
Сокращенное название компании
short_name
STRING
No
---
ИНН
Идентификационный номер налогоплательщика (ИНН)
inn
STRING
Yes
---
КПП
Код причины постановки на учет (КПП)
kpp
STRING
No
---
ОГРН
Основной государственный регистрационный номер (ОГРН)
ogrn
STRING
No
---
Почтовый адрес организации
address
STRING
No
---
Юридический адрес организации
legal_address
STRING
No
---
Вид деятельности организации
activity
STRING
No
---
Web-адрес
Web-адрес сайта/адрес приложения и тд.
url
STRING
No
---
ФИО руководителя организации
head_fullname
STRING
No
---
Должность руководителя организации
head_position
STRING
No
---
Основание на котором действует руководитель
head_base
STRING
No
---
Название банка
bank_name
STRING
No
---
БИК
Банковский идентификационный код (БИК)
bank_bik
STRING
No
---
Номер расчетного счета
bank_account
STRING
No
---
Номер корреспондентского счета
bank_correspondent_account
STRING
No
---
URL обратной связи
URL для взаимодействия с сервисом ШтрафовНет.ру
callback_url
STRING
No
---
Response headers
Key
Value
Content-Type
application/json
Location
https://api.shtrafovnet.ru/latest/dealers/clients/:id
Response parameters
Name
Code
Type
Default
Allowed values
Идентификатор
Уникальный идентификатор аккаунта
id
INTEGER
---
---
Логин
Имя пользователя
username
STRING
---
---
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
---
---
Статус
Состояние аккаунта
status
STRING
new
---
Имя
first_name
STRING
---
---
Фамилия
last_name
STRING
---
---
Отчество
middle_name
STRING
---
---
Телефон
phone
STRING
---
---
Дата создания
Дата регистрации аккаунта
created_at
DATETIME
---
---
Дата последней активности
Дата последней активности пользователя
last_activity_at
DATETIME
NOW()
---
Curl example:
curl --request POST \ --header 'Content-Type:application/json' \ --header 'Authorization:Bearer $TOKEN' \ --data '{"email":"user@test.ru","display_name":"Best Service","name":"Best Service Full","short_name":"BSC","inn":"1234567890","kpp":"644901001","ogrn":"1026402000657","address":"396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657","legal_address":"396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657","activity":"Лизинг","url":"https:\/\/example.com","bank_name":"ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА","bank_bik":"044525225","bank_account":"ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА","bank_correspondent_account":"30101810400000000225","callback_url":"https:\/\/example.com\/postback\/shtrafovnet"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients'
Response example:
HTTP/1.1 201 Created Content-Type:application/json Location:https://api.shtrafovnet.ru/latest/dealers/clients/:id { "id": "777", "username": "User", "email": "user@test.ru", "status": "new", "first_name": "Алексей", "last_name": "Иванов", "middle_name": "Петрович", "phone": "79005551122", "created_at": "2019-01-01 00:00:00", "last_activity_at": "2019-01-01 00:00:00" }

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

Обновление информации о клиенте
PATCH /clients/:email
Request headers
Key
Value
Content-Type
application/json
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
Наименование компании
display_name
STRING
No
---
Полное название компании
Полное название компании без сокращений
name
STRING
No
---
Сокращенное название компании
short_name
STRING
No
---
КПП
Код причины постановки на учет (КПП)
kpp
STRING
No
---
ОГРН
Основной государственный регистрационный номер (ОГРН)
ogrn
STRING
No
---
Почтовый адрес организации
address
STRING
No
---
Юридический адрес организации
legal_address
STRING
No
---
Вид деятельности организации
activity
STRING
No
---
Web-адрес
Web-адрес сайта/адрес приложения и тд.
url
STRING
No
---
ФИО руководителя организации
head_fullname
STRING
No
---
Должность руководителя организации
head_position
STRING
No
---
Основание на котором действует руководитель
head_base
STRING
No
---
Название банка
bank_name
STRING
No
---
БИК
Банковский идентификационный код (БИК)
bank_bik
STRING
No
---
Номер расчетного счета
bank_account
STRING
No
---
Номер корреспондентского счета
bank_correspondent_account
STRING
No
---
URL обратной связи
URL для взаимодействия с сервисом ШтрафовНет.ру
callback_url
STRING
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Идентификатор
Уникальный идентификатор аккаунта
id
INTEGER
---
---
Логин
Имя пользователя
username
STRING
---
---
E-mail
Адрес электронной почты (используется для доступа к аккаунту)
email
STRING
---
---
Статус
Состояние аккаунта
status
STRING
new
---
Имя
first_name
STRING
---
---
Фамилия
last_name
STRING
---
---
Отчество
middle_name
STRING
---
---
Телефон
phone
STRING
---
---
Дата создания
Дата регистрации аккаунта
created_at
DATETIME
---
---
Дата последней активности
Дата последней активности пользователя
last_activity_at
DATETIME
NOW()
---
Curl example:
curl --request PATCH \ --header 'Content-Type:application/json' \ --header 'Authorization:Bearer $TOKEN' \ --data '{"display_name":"Best Service","name":"Best Service Full","short_name":"BSC","kpp":"644901001","ogrn":"1026402000657","address":"396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657","legal_address":"396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657","activity":"Лизинг","url":"https:\/\/example.com","bank_name":"ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА","bank_bik":"044525225","bank_account":"ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА","bank_correspondent_account":"30101810400000000225","callback_url":"https:\/\/example.com\/postback\/shtrafovnet"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "777", "username": "User", "email": "user@test.ru", "status": "new", "first_name": "Алексей", "last_name": "Иванов", "middle_name": "Петрович", "phone": "79005551122", "created_at": "2019-01-01 00:00:00", "last_activity_at": "2019-01-01 00:00:00" }

Удаление клиента

Удаление клиента дилера
DELETE /clients/:email
Path parameters
Code
Описание
email
Электронная почта клиента
Request headers
Key
Value
Authorization
Bearer $TOKEN
Curl example:
curl --request DELETE \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email'
Response example:
HTTP/1.1 204 No Content

Компания

Управление компанией

Информация о компании

Получение информации о дефолтной компании дилера
GET /company
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
ID компании
Уникальный идентификатор компании в системе ШтрафовНет.ру
id
INTEGER
---
---
Наименование компании
display_name
STRING
---
---
Полное название компании
Полное название компании без сокращений
name
STRING
---
---
Сокращенное название компании
short_name
STRING
---
---
Web-адрес
Web-адрес сайта/адрес приложения и тд.
url
STRING
---
---
Состояние аккаунта
status
STRING
active
active, inactive
Дата регистрации аккаунта
created_at
DATETIME
NOW()
---
Почтовый адрес организации
address
STRING
---
---
Юридический адрес организации
legal_address
STRING
---
---
ИНН
Идентификационный номер налогоплательщика (ИНН)
inn
STRING
---
---
КПП
Код причины постановки на учет (КПП)
kpp
STRING
---
---
ОГРН
Основной государственный регистрационный номер (ОГРН)
ogrn
STRING
---
---
БИК
Банковский идентификационный код (БИК)
bank_bik
STRING
---
---
Название банка
bank_name
STRING
---
---
Номер расчетного счета
bank_account
STRING
---
---
Номер корреспондентского счета
bank_correspondent_account
STRING
---
---
Вид деятельности организации
activity
STRING
---
---
ФИО руководителя организации
head_fullname
STRING
---
---
Должность руководителя организации
head_position
STRING
---
---
Основание на котором действует руководитель
head_base
STRING
---
---
ФИО контактного лица
fullname
STRING
---
---
Состояние баланса
Текущее состояние баланса клиента
balance
INTEGER
0
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/company'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "9267", "display_name": "Best Service", "name": "Best Service Full", "short_name": "BSC", "url": "https:\/\/example.com", "status": "active", "created_at": "2019-01-01 00:00:00", "address": "396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657", "legal_address": "396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657", "inn": "1234567890", "kpp": "644901001", "ogrn": "1026402000657", "bank_bik": "044525225", "bank_name": "ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА", "bank_account": "ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА", "bank_correspondent_account": "30101810400000000225", "activity": "Лизинг", "fullname": "Алексей Петрович Иванов" }

Обновление информации компании

Обновление информации о компании
PATCH /company
Request headers
Key
Value
Content-Type
application/json
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
Наименование компании
display_name
STRING
No
---
Полное название компании
Полное название компании без сокращений
name
STRING
No
---
Сокращенное название компании
short_name
STRING
No
---
КПП
Код причины постановки на учет (КПП)
kpp
STRING
No
---
ОГРН
Основной государственный регистрационный номер (ОГРН)
ogrn
STRING
No
---
Почтовый адрес организации
address
STRING
No
---
Юридический адрес организации
legal_address
STRING
No
---
Вид деятельности организации
activity
STRING
No
---
Web-адрес
Web-адрес сайта/адрес приложения и тд.
url
STRING
No
---
ФИО руководителя организации
head_fullname
STRING
No
---
Должность руководителя организации
head_position
STRING
No
---
Основание на котором действует руководитель
head_base
STRING
No
---
Название банка
bank_name
STRING
No
---
БИК
Банковский идентификационный код (БИК)
bank_bik
STRING
No
---
Номер расчетного счета
bank_account
STRING
No
---
Номер корреспондентского счета
bank_correspondent_account
STRING
No
---
URL обратной связи
URL для взаимодействия с сервисом ШтрафовНет.ру
callback_url
STRING
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
ID компании
Уникальный идентификатор компании в системе ШтрафовНет.ру
id
INTEGER
---
---
Наименование компании
display_name
STRING
---
---
Полное название компании
Полное название компании без сокращений
name
STRING
---
---
Сокращенное название компании
short_name
STRING
---
---
Web-адрес
Web-адрес сайта/адрес приложения и тд.
url
STRING
---
---
Состояние аккаунта
status
STRING
active
active, inactive
Дата регистрации аккаунта
created_at
DATETIME
NOW()
---
Почтовый адрес организации
address
STRING
---
---
Юридический адрес организации
legal_address
STRING
---
---
ИНН
Идентификационный номер налогоплательщика (ИНН)
inn
STRING
---
---
КПП
Код причины постановки на учет (КПП)
kpp
STRING
---
---
ОГРН
Основной государственный регистрационный номер (ОГРН)
ogrn
STRING
---
---
БИК
Банковский идентификационный код (БИК)
bank_bik
STRING
---
---
Название банка
bank_name
STRING
---
---
Номер расчетного счета
bank_account
STRING
---
---
Номер корреспондентского счета
bank_correspondent_account
STRING
---
---
Вид деятельности организации
activity
STRING
---
---
ФИО руководителя организации
head_fullname
STRING
---
---
Должность руководителя организации
head_position
STRING
---
---
Основание на котором действует руководитель
head_base
STRING
---
---
ФИО контактного лица
fullname
STRING
---
---
Состояние баланса
Текущее состояние баланса клиента
balance
INTEGER
0
---
Curl example:
curl --request PATCH \ --header 'Content-Type:application/json' \ --header 'Authorization:Bearer $TOKEN' \ --data '{"display_name":"Best Service","name":"Best Service Full","short_name":"BSC","kpp":"644901001","ogrn":"1026402000657","address":"396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657","legal_address":"396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657","activity":"Лизинг","url":"https:\/\/example.com","bank_name":"ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА","bank_bik":"044525225","bank_account":"ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА","bank_correspondent_account":"30101810400000000225","callback_url":"https:\/\/example.com\/postback\/shtrafovnet"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/company'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "9267", "display_name": "Best Service", "name": "Best Service Full", "short_name": "BSC", "url": "https:\/\/example.com", "status": "active", "created_at": "2019-01-01 00:00:00", "address": "396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657", "legal_address": "396005, г.Воронеж, ул.Ворошилова 123, д.23, офис 657", "inn": "1234567890", "kpp": "644901001", "ogrn": "1026402000657", "bank_bik": "044525225", "bank_name": "ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА", "bank_account": "ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\" г. МОСКВА", "bank_correspondent_account": "30101810400000000225", "activity": "Лизинг", "fullname": "Алексей Петрович Иванов" }

Транспорт

Статистика по ТС

Получение статистики по ТС компании
GET /clients/:email/cars/stat
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Stat
stat
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/stat'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "stat": 25 }

Список ТС

Получение списка транспортных средств компании
GET /clients/:email/cars
Query parameters
Name
Code
Type
Allowed values
Статус ТС
Условие на выборку ТС по статусу
status
STRING OR ARRAY
new, active, inactive, archived
Номер СТС
Фильтрация по номеру СТС
cert
STRING
---
Госномер
Фильтрация по номеру РГЗ
reg
STRING
---
Название ТС
Фильтрация по названию ТС
name
STRING
---
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Общее количество транспортных средств
Общее количество счетов (по заданным критериям)
total
INTEGER
---
---
Текущее количество транспортных средств в запросе
Текущее количество счетов в запросе (по заданным критериям)
count
INTEGER
---
---
Пагинация
Объект содержит содержит ключи, указывающие взаимосвязь дополнительных страниц
_links
ARRAY
---
---
Список транспортных средств
Объект содержит информацию о транспортных средствах
cars
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars?status=new&cert=4619689062&reg=%D0%B0001%D0%B0%D0%B0777&name=Nissan+Tiida'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "total": 1, "count": 1, "_links": "https:\/\/api.shtrafovnet.ru\/latest\/dealers\/clients\/:email\/cars?page=1", "cars": { "id": "1212", "name": "NISSAN TIIDA", "driverLicense": "00aa000222", "reg": "a001aa777", "cert": "3620848236", "status": "active", "inactiveReason": "data_incorrect", "scannedAt": "2019-01-01 00:00:00", "gisScannedAt": "2019-01-01 00:00:00", "gibddScannedAt": "2019-01-01 00:00:00", "ditScannedAt": "2019-01-01 00:00:00", "createdAt": "2019-01-01 00:00:00", "companyId": "1", "user": "user@test.ru", "verifyGibddStatus": "new", "finesCount": "10", "finesAmount": "1000", "unitId": "a828a501-a293-4ca4-b747-f61b60f24181" } }

Получение информации о ТС

Получение информации о транспортном средстве
GET /clients/:email/cars/:id
Path parameters
Code
Описание
id
Уникальный идентификатор транспортного средства
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
ID транспортного средства
Уникальный идентификатор транспортного средства в системе ШтрафовНет.ру
id
INTEGER
---
---
Название ТС
Название/модель транспортного средства
name
STRING
---
---
Госномер
Фильтрация по номеру РГЗ
reg
STRING
---
---
Свидетельство о регистрации
Фильтрация по номеру СТС
cert
STRING
---
---
Статус
Условие на выборку ТС по статусу
status
STRING
new
new, active, inactive, archived
Причина нактивности
Причина нактивности ТС в системе ШтрафовНет.ру
inactiveReason
STRING
---
gibdd_verify, data_incorrect
Дата последней проверки в ГИС
Дата/время последней проверки транспортного средства в системе ГИС ГМП
gisScannedAt
DATETIME
---
---
Дата последней проверки в ГИБДД
Дата/время последней проверки транспортного средства в системе ГИБДД
gibddScannedAt
DATETIME
---
---
Дата последней проверки в ДИТ
Дата/время последней проверки транспортного средства в системе московского департамента автотранспорта
ditScannedAt
DATETIME
---
---
Дата добавления ТС
Дата/время добавления транспортного средства в систему
createdAt
DATETIME
---
---
ID компании
Уникальный идентификатор компании
companyId
INTEGER
---
---
Количество штрафов
Количество неоплаченных штрафов ТС
finesCount
INTEGER
---
---
Сумма задолженности
Сумма задолженности по штрафам ТС
finesAmount
FLOAT
---
---
Автопарк
Автопарк, которому принадлежит ТС
unitId
STRING
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/:id'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "1212", "name": "Ford Focus 2 2006", "reg": "a001aa777", "cert": "3620848236", "status": "new", "inactiveReason": "data_incorrect", "gisScannedAt": "2019-01-01 00:00:00", "gibddScannedAt": "2019-01-01 00:00:00", "ditScannedAt": "2019-01-01 00:00:00", "createdAt": "2019-01-01 00:00:00", "companyId": "1", "finesCount": "10", "finesAmount": "1000", "unitId": "a828a501-a293-4ca4-b747-f61b60f24181" }

Новое транспортное средство

Добавление нового транспортного средства
POST /clients/:email/cars
Request headers
Key
Value
Content-Type
application/json
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
Свидетельство о регистрации
Фильтрация по номеру СТС
cert
STRING
Yes
---
Госномер
Фильтрация по номеру РГЗ
reg
STRING
Yes
---
Название ТС
Название/модель транспортного средства
name
STRING
No
---
Response headers
Key
Value
Content-Type
application/json
Location
https://api.shtrafovnet.ru/latest/dealers/clients/{email}/cars/:id
Response parameters
Name
Code
Type
Default
Allowed values
ID транспортного средства
Уникальный идентификатор транспортного средства в системе ШтрафовНет.ру
id
INTEGER
---
---
Название ТС
Название/модель транспортного средства
name
STRING
---
---
Госномер
Фильтрация по номеру РГЗ
reg
STRING
---
---
Свидетельство о регистрации
Фильтрация по номеру СТС
cert
STRING
---
---
Статус
Условие на выборку ТС по статусу
status
STRING
new
new, active, inactive, archived
Причина нактивности
Причина нактивности ТС в системе ШтрафовНет.ру
inactiveReason
STRING
---
gibdd_verify, data_incorrect
Дата последней проверки в ГИС
Дата/время последней проверки транспортного средства в системе ГИС ГМП
gisScannedAt
DATETIME
---
---
Дата последней проверки в ГИБДД
Дата/время последней проверки транспортного средства в системе ГИБДД
gibddScannedAt
DATETIME
---
---
Дата последней проверки в ДИТ
Дата/время последней проверки транспортного средства в системе московского департамента автотранспорта
ditScannedAt
DATETIME
---
---
Дата добавления ТС
Дата/время добавления транспортного средства в систему
createdAt
DATETIME
---
---
ID компании
Уникальный идентификатор компании
companyId
INTEGER
---
---
Количество штрафов
Количество неоплаченных штрафов ТС
finesCount
INTEGER
---
---
Сумма задолженности
Сумма задолженности по штрафам ТС
finesAmount
FLOAT
---
---
Автопарк
Автопарк, которому принадлежит ТС
unitId
STRING
---
---
Curl example:
curl --request POST \ --header 'Content-Type:application/json' \ --header 'Authorization:Bearer $TOKEN' \ --data '{"cert":"3620848236","reg":"a001aa777","name":"Ford Focus 2 2006"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars'
Response example:
HTTP/1.1 201 Created Content-Type:application/json Location:https://api.shtrafovnet.ru/latest/dealers/clients/{email}/cars/:id { "id": "1212", "name": "Ford Focus 2 2006", "reg": "a001aa777", "cert": "3620848236", "status": "new", "inactiveReason": "data_incorrect", "gisScannedAt": "2019-01-01 00:00:00", "gibddScannedAt": "2019-01-01 00:00:00", "ditScannedAt": "2019-01-01 00:00:00", "createdAt": "2019-01-01 00:00:00", "companyId": "1", "finesCount": "10", "finesAmount": "1000", "unitId": "a828a501-a293-4ca4-b747-f61b60f24181" }

Обновление транспортного средства

Обновление данных о транспортном средстве.
Данный метод позволяет изменить только необходимые поля не передавая всю информацию о транспортном средстве.

По религиозным соображениям изменение СТС и госномера, а так же ВУ не допускается, но вы можете удалить ТС и добавить новое.

PATCH /clients/:email/cars/:id
Path parameters
Code
Описание
id
Уникальный идентификатор транспортного средства
Request headers
Key
Value
Content-Type
application/json
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
Название ТС
Название/модель транспортного средства
name
STRING
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
ID транспортного средства
Уникальный идентификатор транспортного средства в системе ШтрафовНет.ру
id
INTEGER
---
---
Название ТС
Название/модель транспортного средства
name
STRING
---
---
Госномер
Фильтрация по номеру РГЗ
reg
STRING
---
---
Свидетельство о регистрации
Фильтрация по номеру СТС
cert
STRING
---
---
Статус
Условие на выборку ТС по статусу
status
STRING
new
new, active, inactive, archived
Причина нактивности
Причина нактивности ТС в системе ШтрафовНет.ру
inactiveReason
STRING
---
gibdd_verify, data_incorrect
Дата последней проверки в ГИС
Дата/время последней проверки транспортного средства в системе ГИС ГМП
gisScannedAt
DATETIME
---
---
Дата последней проверки в ГИБДД
Дата/время последней проверки транспортного средства в системе ГИБДД
gibddScannedAt
DATETIME
---
---
Дата последней проверки в ДИТ
Дата/время последней проверки транспортного средства в системе московского департамента автотранспорта
ditScannedAt
DATETIME
---
---
Дата добавления ТС
Дата/время добавления транспортного средства в систему
createdAt
DATETIME
---
---
ID компании
Уникальный идентификатор компании
companyId
INTEGER
---
---
Количество штрафов
Количество неоплаченных штрафов ТС
finesCount
INTEGER
---
---
Сумма задолженности
Сумма задолженности по штрафам ТС
finesAmount
FLOAT
---
---
Автопарк
Автопарк, которому принадлежит ТС
unitId
STRING
---
---
Curl example:
curl --request PATCH \ --header 'Content-Type:application/json' \ --header 'Authorization:Bearer $TOKEN' \ --data '{"name":"Ford Focus 2 2006"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/:id'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "1212", "name": "Ford Focus 2 2006", "reg": "a001aa777", "cert": "3620848236", "status": "new", "inactiveReason": "data_incorrect", "gisScannedAt": "2019-01-01 00:00:00", "gibddScannedAt": "2019-01-01 00:00:00", "ditScannedAt": "2019-01-01 00:00:00", "createdAt": "2019-01-01 00:00:00", "companyId": "1", "finesCount": "10", "finesAmount": "1000", "unitId": "a828a501-a293-4ca4-b747-f61b60f24181" }

Удаление транспортного средства

Удаление транспортного средства. Метод всегда возвращает пустое тело ответа.
DELETE /clients/:email/cars/:id
Path parameters
Code
Описание
id
Уникальный идентификатор транспортного средства
Request headers
Key
Value
Authorization
Bearer $TOKEN
Curl example:
curl --request DELETE \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/:id'
Response example:
HTTP/1.1 204 No Content

Сброс неактивных ТС

Сброс статуса неактивных транспортных средств для повторной проверки и валидации
POST /clients/:email/cars/actions/flush_inactive
Request headers
Key
Value
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
ID транспортных стредств
car_ids
ARRAY
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Сообщение
message
STRING
---
---
Curl example:
curl --request POST \ --header 'Authorization:Bearer $TOKEN' \ --data '{"car_ids":["1","2"]}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/actions/flush_inactive'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "message": "The status of inactive cars is reset" }

Удаление неактивных ТС

Удаление неактивных транспортных средств
POST /clients/:email/cars/actions/remove_inactive
Request headers
Key
Value
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
ID транспортных стредств
car_ids
ARRAY
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Сообщение
message
STRING
---
---
Curl example:
curl --request POST \ --header 'Authorization:Bearer $TOKEN' \ --data '{"car_ids":["1","2"]}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/actions/remove_inactive'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "message": "Inactive cars removed" }

Добавление в архив

Добавление транспортных средств в архив (set status = 'archived')
POST /clients/:email/cars/actions/archive
Request headers
Key
Value
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
ID транспортных стредств
car_ids
ARRAY
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Сообщение
message
STRING
---
---
Curl example:
curl --request POST \ --header 'Authorization:Bearer $TOKEN' \ --data '{"car_ids":["1","2"]}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/actions/archive'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "message": "Cars added to the archive" }

Извлечение из архива

Удаление транспортных средств из архива (set status = 'active')
POST /clients/:email/cars/actions/unarchive
Request headers
Key
Value
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
ID транспортных стредств
car_ids
ARRAY
No
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Сообщение
message
STRING
---
---
Curl example:
curl --request POST \ --header 'Authorization:Bearer $TOKEN' \ --data '{"car_ids":["1","2"]}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/actions/unarchive'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "message": "Cars removed from the archive" }

Выгрузка в Excel

Выгрузка транспортных средств в excel-файл
POST /clients/:email/cars/actions/export
Query parameters
Name
Code
Type
Allowed values
Статус
Условие на выборку ТС по статусу
status
STRING
new, active, inactive, archived
Свидетельство о регистрации
Фильтрация по номеру СТС
cert
STRING
---
Госномер
Фильтрация по номеру РГЗ
reg
STRING
---
Название ТС
Фильтрация по названию ТС
name
STRING
---
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Результат попытки экспорта
response
ARRAY
---
---
Curl example:
curl --request POST \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/actions/export?status=new&cert=3620848236&reg=a001aa777&name=Nissan+Tiida'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "response": "https:\/\/shtrafovnet-dev.s3.eu-west-1.amazonaws.com\/clients\/aab3238922bcc25a6f606eb525ffdc56\/export\/cars\/2019\/02\/22\/cars_export_14_20190222134430.xlsx" }

Массовая загрузка ТС

Массовая загрузка ТС из Excel или CSV файла
POST /clients/:email/cars/actions/load
Request headers
Key
Value
Content-Type
text/csv | application/json | application/vnd.ms-excel
Authorization
Bearer $TOKEN
Upload File
Name
Required?
Файл для импорта
Yes
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Результат попытки импорта
import
ARRAY
---
---
Curl example:
curl --request POST \ --header 'Content-Type:text/csv | application/json | application/vnd.ms-excel' \ --header 'Authorization:Bearer $TOKEN' \ --data '$content' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/cars/actions/load'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "import": { "added": [], "updated": [], "error": [], "double": [] } }

Штрафы

Список штрафов

Получение списка штрафов клиента
GET /clients/:email/fines
Query parameters
Name
Code
Type
Allowed values
Статус платежа
Фильтрация по статусам оплаты штрафа
paid
STRING OR ARRAY
na, nopaid, prepaid, partpaid, paid, cancel
Статус платежа
Фильтрация по статусам штрафа
status
STRING OR ARRAY
check, active, inactive, deleted, archived
Авто
Фильтрация списка штрафов по авто
cars
STRING OR ARRAY
---
ID штрафа
Фильтрация списка штрафов по идентификаторам штрафов
fines
STRING OR ARRAY
---
UIN штрафа
Фильтрация списка штрафов по номерам УИН
uins
STRING OR ARRAY
---
Часть номера УИН
Фильтрация списка штрафов по части номера УИН
uin_search
STRING
---
Документ
Фильтрация списка штрафов по документу
doc
STRING OR ARRAY
sts, vu, inn, rawid, snils, passport
Администратор начисления
Фильтрация списка штрафов по администратору начисления
org
STRING OR ARRAY
gibdd, madi, ampp, fssp
Индикаторы
Фильтрация списка штрафов по индикаторам
filters
STRING OR ARRAY
new, discount, expired, pics
Дата постановления (больше)
Фильтрация по дате постановления (больше чем YYYY-MM-DD)
started
STRING
---
Дата постановления (меньше)
Фильтрация по дате постановления (меньше чем YYYY-MM-DD)
ended
STRING
---
Дата создания (больше)
Фильтрация по дате создания (больше чем YYYY-MM-DD 00:00:00)
create_started
STRING
---
Дата создания (меньше)
Фильтрация по дате создания (больше чем YYYY-MM-DD 00:00:00)
create_ended
STRING
---
Дата обновления (больше)
Фильтрация по дате обновления (больше чем YYYY-MM-DD 00:00:00)
update_started
STRING
---
Дата обновления (меньше)
Фильтрация по дате обновления (больше чем YYYY-MM-DD 00:00:00)
update_ended
STRING
---
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Общее количество штрафов
Общее количество штрафов (по заданным критериям)
total
INTEGER
---
---
Текущее количество штрафов
Текущее количество штрафов в запросе (по заданным критериям)
count
INTEGER
---
---
Пагинация
Объект содержит содержит ключи, указывающие взаимосвязь дополнительных страниц
_links
ARRAY
---
---
Информация о штрафах
Объект содержит информацию о штрафах
fines
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/fines?paid=na&status=active&cars=200&fines=200&uins=12345678901234567890&uin_search=1234567&doc=sts&org=gibdd&filters=new&started=2019-01-22&ended=2019-02-22&create_started=2019-01-16&create_ended=2019-01-16&update_started=2019-01-16&update_ended=2019-01-16'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "total": 1, "count": 1, "_links": "https:\/\/api.shtrafovnet.ru\/latest\/dealers\/clients\/:email\/fines?page=1", "fines": { "id": "1", "postNumber": "18810136161108008161", "name": null, "postedAt": "2019-01-01", "amount": "500", "actuallyPaidAmount": null, "actuallyPaidAt": "2019-01-01 00:00:00", "createdAt": "2019-01-01 00:00:00", "discountDate": "2019-01-01 23:59:59", "discountSize": "50", "wireKbk": "18811630020016000140", "wireUsername": "УФК по Воронежской обл. (ГУ МВД России по Воронежской области)", "wireOktmo": "20701000", "wireBankBik": "042007001", "wireBankAccount": "40101810500000010004", "wireBankName": "Отделение по Воронежской области ГУ ЦБ РФ по ЦФО (Отделение Воронеж)", "wireKpp": "366601001", "wireInn": "3666026374", "location": null, "locationLat": null, "locationLong": null, "koapCode": "12.9ч.2", "enablePics": "true", "loadPics": "1", "violationAt": "2019-01-01 00:00:00", "isGis": "true", "isGibdd": "true", "isDit": "true", "isUin": "true", "status": "check", "inactiveReason": "another_car", "pics": { "url": "https:\/\/s3.eu-central-1.amazonaws.com\/shtrafovnetru\/pics\/2017\/02\/14\/09\/cad29d806521c20c9f2aeb98d5ec5445.jpg" }, "docType": "sts", "docNumber": "3620848239", "docViolator": null, "updatedAt": "2019-01-01 00:00:00", "updatedMask": "0011", "fsspIp": "", "fsspUin": "", "isPaidMarked": "", "isPaid": "true", "paidStatus": "paid", "koapText": "", "isExpired": "true", "expiredDays": "", "penaltyDate": "2019-01-01 23:59:59", "discountDaysLeft": "0", "isDiscount": "false", "totalAmount": "500", "car": "1003726", "carName": "KIA OPTIMA", "carCert": "3620848239", "carReg": "р668хо36", "whoseOrg": "gibdd", "paymentOrderUrl": "https:\/\/shtrafovnet.ru\/payment_report?operation_id=12345&uin=1880000000000001", "divisionName": "Центр видеофиксации ГИБДД ГУ МВД России по Воронежской области", "divisionCode": "1120951", "paidAmount": "0.00", "unitId": "a828a501-a293-4ca4-b747-f61b60f24181", "companyId": "200" } }

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

Получение информации по штрафу клиента
GET /clients/:email/fines/:id
Path parameters
Code
Описание
id
Уникальный идентификатор штрафа
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
ID штрафа
Уникальный идентификатор штрафа в системе ШтрафовНет.ру
id
INTEGER
---
---
Номер постановления
Уникальный идентификатор начисления
postNumber
STRING
---
---
Название
Строка содержащая краткую информацию о постановлении
name
STRING
---
---
Дата постановления
Дата вынесения постановления (она не всегда совпадает с реальной датой нарушения)
postedAt
DATETIME
---
---
Сумма штрафа
Сумма штрафа (в рублях)
amount
INTEGER
0
---
Актуальная сумма оплаты
Актуальная сумма оплаты
actuallyPaidAmount
FLOAT
0
---
Актуальная дата оплаты
Актуальная дата оплаты
actuallyPaidAt
DATETIME
---
---
Дата создания штрафа
Дата создания штрафа в системе ШтрафовНет.ру
createdAt
DATETIME
---
---
Дата скидки
Дата до которой действует скидка на оплату штрафа (включительно до 23:59)
discountDate
DATETIME
---
---
Размер скидки
Размер скидки в процентах (при наличии)
discountSize
INTEGER
0
---
КБК
КБК (Код бюджетной классификации)
wireKbk
STRING
---
---
Получатель платежа
Наименование получателя платежа
wireUsername
STRING
---
---
ОКТМО
Общероссийский классификатор территорий муниципальных образований
wireOktmo
STRING
---
---
БИК банка получателя
БИК банка получателя платежа
wireBankBik
STRING
---
---
Номер счёта получателя
Расчетный счет получателя платежа
wireBankAccount
STRING
---
---
Название банка
Название банка получателя платежа
wireBankName
STRING
---
---
КПП
КПП получателя платежа
wireKpp
STRING
---
---
ИНН
ИНН получателя платежа
wireInn
STRING
---
---
Место совершения павонарушения
Описание места совершения правонарушения
location
STRING
---
---
Географические координаты (широта)
Географические координаты (широта) места нарушения
locationLat
STRING
---
---
Географические координаты (долгота)
Географические координаты (долгота) места нарушения
locationLong
STRING
---
---
Наименование статьи КОАП
Наименование статьи КОАП
koapCode
STRING
---
---
Флаг наличия изображений
Флаг указывающий о наличии для данного постановления изображений правонарушения
enablePics
BOOLEAN
---
true, false
Статус загрузки изображений
0 — Изображения правонарушения поставлены в очередь на загрузку (если имеются); 1 — Изображения успешно загружены; 2 — Не удалось получить фотографии правонарушения. Попытки загрузки продолжаются. (Это чаще всего случается при обращении серверов ГИБДД за фотографиями к региональным подразделениям); 3 — После многочисленных попыток загрузки изображений правонарушения, так и не удалось их получить.
loadPics
INTEGER
0
0, 1, 2, 3
Дата и время правонарушения
Реальная дата и время когда было совершено правонарушение
violationAt
DATETIME
---
---
Флаг ГИС ГМП
Флаг информирующий о том, что штраф получен в системе ГИС ГМП
isGis
BOOLEAN
---
true, false
Флаг ГИБДД
Флаг информирующий о том, что штраф получен в системе ГИБДД
isGibdd
BOOLEAN
---
true, false
Флаг ДИТ
Флаг информирующий о том, что штраф получен в системе московского департамента автотранспорта
isDit
BOOLEAN
---
true, false
isUin
BOOLEAN
---
true, false
Статус штрафа
status
STRING
check
check, active, inactive, deleted
Причина неактивности штрафа
inactiveReason
STRING
---
another_car, not_found, incorrect
Список изображений
Список изображений правонарушения доступных для данного постановления
pics
STRING
---
---
Тип документа
Тип документа на который выписано постановление
docType
STRING
---
sts, vu, inn, rawid, passport, snils
Номер документа
Номер документа на который выписано постановление
docNumber
STRING
---
---
Нарушитель
Фамилия Имя Отчество нарушителя или наименование организации
docViolator
STRING
---
---
Дата/время последнего изменения
Дата/время последнего изменения штрафа (создание, статус оплаты, детали, фотоматериалы)
updatedAt
DATETIME
---
---
Причина последнего обновления штрафа
Вспомогательный параметр, отражающий причину последнего обновления штрафа. Каждый символ отражает факт обновления/неизменности определенного блока информации о штрафе. Первый символ (если 1), указывает, что это новый штраф. Второй символ (если 1), указывает, что состояние штрафа было изменено (оплачен). Третий символ (если 1), указывает, что у штрафа обновилась дополнительная информация (например: статья КОАП). Четвертый символ (если 1), указывает, что у штрафа появились фотографии фотофиксации правонарушения.
updatedMask
STRING
---
---
fsspIp
STRING
---
---
fsspUin
STRING
---
---
isPaidMarked
BOOLEAN
---
true, false
Текущие состояние оплаты постановления
Текущие состояние оплаты постановления (paid - полностью оплачен, nopaid - неоплачен, partpaid - частичная оплата/переплата штрафа)
paidStatus
STRING
---
paid, nopaid, partpaid
Статья КОАП
Краткое описание статьи КОАП
koapText
STRING
---
---
Флаг неоплаты в 70-ти дневный период
Флаг информирующий о том, что штраф не оплачен в 70-ти дневный период
isExpired
BOOLEAN
---
true, false
Количество дней просрочки
Количество дней на которые просрочена оплата штрафа
expiredDays
INTEGER
---
---
Дата, передачи в службу ФССП
Дата, после которой штраф будет передан в службу ФССП (70 дней с момента выставления постановления)
penaltyDate
DATETIME
---
---
Количество дней оставшихся на оплату штрафа со скидкой
Количество дней оставшихся на оплату штрафа со скидкой
discountDaysLeft
INTEGER
---
---
Возможность оплатить со скидкой
Флаг информирующий о возможности оплатить штраф со скидкой
isDiscount
BOOLEAN
---
true, false
Итоговая сумма штрафа к оплате
Итоговая сумма штрафа к оплате с учетом всевозможных скидок (в рублях)
totalAmount
INTEGER
---
---
ID транспортного средства
Уникальный идентификатор транспортного средства
car
INTEGER
---
---
Название ТС
Название транспортного средства
carName
STRING
---
---
СТС
Свидетельство о регистрации транспортного средства
carCert
STRING
---
---
Госномер ТС
Номер государственного регистрационного знака транспортного средства
carReg
STRING
---
---
Организация постановления
Организация, которой принадлежит данное постановление
whoseOrg
STRING
---
gibdd, ampp, madi, fssp
Администратор начисления
Наименование администратора начисления (подразделение ГИБДД РФ)
divisionName
STRING
---
---
Код подразделения ГИБДД
Уникальный код подразделения ГИБДД
divisionCode
STRING
---
---
Автопарк
Автопарк, которому принадлежит штраф
unitId
INTEGER
---
---
Компания
Компания, которой принадлежит штраф
companyId
INTEGER
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/fines/:id'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "1", "postNumber": "18810136161108008161", "postedAt": "2019-01-01", "amount": "500", "actuallyPaidAt": "2019-01-01 00:00:00", "createdAt": "2019-01-01 00:00:00", "discountDate": "2019-01-01 23:59:59", "discountSize": "50", "wireKbk": "18811630020016000140", "wireUsername": "УФК по Воронежской обл. (ГУ МВД России по Воронежской области)", "wireOktmo": "20701000", "wireBankBik": "042007001", "wireBankAccount": "40101810500000010004", "wireBankName": "Отделение по Воронежской области ГУ ЦБ РФ по ЦФО (Отделение Воронеж)", "wireKpp": "366601001", "wireInn": "3666026374", "koapCode": "12.9ч.2", "enablePics": "true", "loadPics": "1", "violationAt": "2019-01-01 00:00:00", "isGis": "true", "isGibdd": "true", "isDit": "true", "isUin": "true", "status": "check", "inactiveReason": "another_car", "pics": "https:\/\/s3.eu-central-1.amazonaws.com\/shtrafovnetru\/pics\/2017\/02\/14\/09\/cad29d806521c20c9f2aeb98d5ec5445.jpg", "docType": "sts", "docNumber": "3620848239", "updatedAt": "2019-01-01 00:00:00", "updatedMask": "0011", "paidStatus": "paid", "isExpired": "true", "penaltyDate": "2019-01-01 23:59:59", "isDiscount": "false", "totalAmount": "500", "car": "1003726", "carName": "KIA OPTIMA", "carCert": "3620848239", "carReg": "р668хо36", "whoseOrg": "gibdd", "divisionName": "Центр видеофиксации ГИБДД ГУ МВД России по Воронежской области", "divisionCode": "1120951", "unitId": "a828a501-a293-4ca4-b747-f61b60f24181", "companyId": "200" }

Перевод в "оплачен"

Ручная установка статуса оплаты на "Оплачен"
POST /clients/:email/fines/actions/mark-paid
Request headers
Key
Value
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
ID штрафов
fine_ids
ARRAY
Yes
---
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Сообщение
message
STRING
---
---
Curl example:
curl --request POST \ --header 'Authorization:Bearer $TOKEN' \ --data '{"fine_ids":["1","2"]}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/fines/actions/mark-paid'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "message": "All fines are marked as paid" }

Выгрузка в Excel

Экспорт штрафов клиента в excel-файл
POST /clients/:email/fines/actions/export
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Location
$location
Response parameters
Name
Code
Type
Default
Allowed values
Информация о задаче по выгрузке штрафов
task
ARRAY
---
---
Curl example:
curl --request POST \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/fines/actions/export'
Response example:
HTTP/1.1 201 Created Content-Type:application/json Location:$location { "task": "2019-01-22 00:00:00" }

Статус экспорта

Проверка статуса выполнения задачи по экспорту
GET /clients/:email/fines/actions/export/:id
Path parameters
Code
Описание
id
Уникальный идентификатор штрафа
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Информация о задаче
response
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/fines/actions/export/:id'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "response": "2019-01-22 00:00:00" }

Тарифы

Список тарифов

Список тарифов на информационное обслуживание
GET /tariffs
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Общее количество тарифов
Общее количество тарифов (по заданным критериям)
total
INTEGER
---
---
Текущее количество тарифов
Текущее количество тарифов в запросе (по заданным критериям)
count
INTEGER
---
---
Пагинация
Объект содержит содержит ключи, указывающие взаимосвязь дополнительных страниц
_links
ARRAY
---
---
Информация о тарифах
Объект содержит информацию о тарифах
tariffs
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/tariffs'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "total": 1, "count": 1, "_links": "https:\/\/api.shtrafovnet.ru\/latest\/dealers\/tariffs?page=1", "tariffs": { "id": "1", "min_cars": "10", "max_cars": "20", "scan_period": "day", "price": "4500", "price_per_car": "4500" } }

Информационное обслуживание

Список ИО

Получение списка информационных обслуживаний клиента
GET /clients/:email/services
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Общее количество ИО
Общее количество ИО (по заданным критериям)
total
INTEGER
---
---
Текущее количество ИО
Текущее количество ИО в запросе (по заданным критериям)
count
INTEGER
---
---
Пагинация
Объект содержит содержит ключи, указывающие взаимосвязь дополнительных страниц
_links
ARRAY
---
---
Информация об информационных обслуживаниях
Объект содержит информацию об ИО
services
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/services'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "total": 1, "count": 1, "_links": "https:\/\/api.shtrafovnet.ru\/latest\/dealers\/clients\/:email\/services?page=1", "services": { "id": "1", "started_at": "2019-01-01 00:00:00", "ended_at": "2019-01-01 00:00:00", "created_at": "2019-01-01 00:00:00", "invoice_id": "3290", "tariff_id": "10", "is_current": "false", "days_left": "2" } }

Информация об услуге

Получение информации по информационному обслуживанию
GET /clients/:email/services/:id
Path parameters
Code
Описание
id
Уникальный иденитификатор информационного обслуживания
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
ID информационного обслуживания
Уникальный идентификатор услуги информационного обслуживания
id
INTEGER
---
---
Дата/время начала
Дата/время с которого действует данная услуга
started_at
DATETIME
---
---
Дата/время окончания
Дата/время до которой действует данная услуга
ended_at
DATETIME
---
---
Дата создания
Дата/время создания услуги
created_at
DATETIME
NOW()
---
ID счета
Уникальный идентификатор счета для текущего информационного обслуживания
invoice_id
INTEGER
---
---
ID тарифа
Уникальный идентификатор тарифа для текущего информационного обслуживания
tariff_id
INTEGER
---
---
Флаг текущего обслуживания
Флаг, указывающий на то что информационное обслуживание является текущим
is_current
BOOLEAN
---
---
Дней до окончания
Количеcтво дней, оставшихся до окончания обслуживания
days_left
INTEGER
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/services/:id'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "1", "started_at": "2019-01-01 00:00:00", "ended_at": "2019-01-01 00:00:00", "created_at": "2019-01-01 00:00:00", "invoice_id": "3290", "tariff_id": "10", "is_current": "false", "days_left": "2" }

Новое ИО

Выставление счета на информационное обслуживание
POST /clients/:email/services
Request headers
Key
Value
Content-Type
application/json
Authorization
Bearer $TOKEN
Request parameters
Name
Code
Type
Required?
Allowed values
ID тарифа
Уникальный идентификатор тарифа для текущего информационного обслуживания
tariff_id
INTEGER
Yes
---
Количество месяцев
Срок действия информационного обслуживания
months
INTEGER
Yes
---
Response headers
Key
Value
Content-Type
application/json
Location
https://api.shtrafovnet.ru/latest/dealers/clients/{email}/services/:id
Response parameters
Name
Code
Type
Default
Allowed values
ID счета
Уникальный идентификатор счета
id
INTEGER
---
---
Номер счета
Уникальный номер счета
number
STRING
---
---
Комментарий
Краткое описание выставленного счета
comment
STRING
---
---
Итоговая сумма
Итоговая сумма на оплату счета
price
INTEGER
0
---
Статус счета
Текущее состояние счета Возможные значения: wait, cancel, done, Значение по умолчанию: wait
status
STRING
wait
done, cancel, wait
Дата создания
Дата создания счета
created_at
DATETIME
---
---
Дата оплаты
Дата оплаты счета
paid_at
DATETIME
---
---
Список услуг
Список продуктов/товаров/услуг указанных в счете
items
ARRAY
---
---
Имя
Описание позиции в счете
name
STRING
---
---
Цена, руб.
Цена за единицу
price
FLOAT
0
---
Количество
Количество товара/услуг в позиции
quantity
INTEGER
1
---
Скидка, %
Предоставляемая скидка на позицию
discount
INTEGER
0
---
Налог, %
Наценка на позицию
tax
INTEGER
0
---
Единица измерения
Тип позиции
unit
STRING
---
pc, service, hour, day, month
Итоговая цена, руб.
Итоговая стоимость позиции с учетом предоставляемой скидки и наценки
total_price
FLOAT
0
---
Ссылка на счет
Ссылка на pdf-файл счета на оплату
pdf_url
STRING
---
---
Curl example:
curl --request POST \ --header 'Content-Type:application/json' \ --header 'Authorization:Bearer $TOKEN' \ --data '{"tariff_id":"10","months":"1"}' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/services'
Response example:
HTTP/1.1 201 Created Content-Type:application/json Location:https://api.shtrafovnet.ru/latest/dealers/clients/{email}/services/:id { "id": "996", "number": "ИО-00597", "comment": "ИО-00597", "price": "4675", "status": "done", "created_at": "2019-01-10", "paid_at": "2019-01-10", "items": { "name": "Информационное обслуживание за ООО \\\"Best Company\\\". Ежедневная проверка штрафов ГИБДД (11-50 ТС)", "price": "5500", "quantity": "1", "discount": "15", "tax": "0", "unit": "month", "total_price": "4675" }, "pdf_url": "https:\/\/s3-eu-west-1.amazonaws.com\/shtrafovnet\/payment\/invoices\/2017\/06\/12\/142338_20170612_invoice_*****.pdf" }

Счета

Список счетов

Получение списка счетов компании
GET /clients/:email/invoices
Query parameters
Name
Code
Type
Allowed values
Статус платежа
Условие на выборку счетов веб-мастера по статусу
status
STRING OR ARRAY
new, wait, cancel, done
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
Общее количество счетов
Общее количество счетов (по заданным критериям)
total
INTEGER
---
---
Текущее количество счетов
Текущее количество счетов в запросе (по заданным критериям)
count
INTEGER
---
---
Пагинация
Объект содержит содержит ключи, указывающие взаимосвязь дополнительных страниц
_links
ARRAY
---
---
Информация о счетах
Объект содержит информацию о счетах
invoices
ARRAY
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/invoices?status=new'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "total": 1, "count": 1, "_links": "https:\/\/api.shtrafovnet.ru\/latest\/dealers\/clients\/:email\/invoices?page=1", "invoices": { "id": "996", "number": "ИО-00597", "comment": "ИО-00597", "price": "4675", "status": "done", "created_at": "2019-01-10", "paid_at": "2019-01-10", "items": [ {} ], "pdf_url": "https:\/\/s3-eu-west-1.amazonaws.com\/shtrafovnet\/payment\/invoices\/2017\/06\/12\/142338_20170612_invoice_*****.pdf" } }

Информация по счету

Получение подробной информации о счете
GET /clients/:email/invoices:id
Path parameters
Code
Описание
id
Уникальный иденитификатор счета
Request headers
Key
Value
Authorization
Bearer $TOKEN
Response headers
Key
Value
Content-Type
application/json
Response parameters
Name
Code
Type
Default
Allowed values
ID счета
Уникальный идентификатор счета
id
INTEGER
---
---
Номер счета
Уникальный номер счета
number
STRING
---
---
Комментарий
Краткое описание выставленного счета
comment
STRING
---
---
Итоговая сумма
Итоговая сумма на оплату счета
price
INTEGER
0
---
Статус счета
Текущее состояние счета Возможные значения: wait, cancel, done, Значение по умолчанию: wait
status
STRING
wait
done, cancel, wait
Дата создания
Дата создания счета
created_at
DATETIME
---
---
Дата оплаты
Дата оплаты счета
paid_at
DATETIME
---
---
Список услуг
Список продуктов/товаров/услуг указанных в счете
items
ARRAY
---
---
Имя
Описание позиции в счете
name
STRING
---
---
Цена, руб.
Цена за единицу
price
FLOAT
0
---
Количество
Количество товара/услуг в позиции
quantity
INTEGER
1
---
Скидка, %
Предоставляемая скидка на позицию
discount
INTEGER
0
---
Налог, %
Наценка на позицию
tax
INTEGER
0
---
Единица измерения
Тип позиции
unit
STRING
---
pc, service, hour, day, month
Итоговая цена, руб.
Итоговая стоимость позиции с учетом предоставляемой скидки и наценки
total_price
FLOAT
0
---
Ссылка на счет
Ссылка на pdf-файл счета на оплату
pdf_url
STRING
---
---
Curl example:
curl --request GET \ --header 'Authorization:Bearer $TOKEN' \ --url 'https://api.shtrafovnet.ru/latest/dealers/clients/:email/invoices:id'
Response example:
HTTP/1.1 200 OK Content-Type:application/json { "id": "996", "number": "ИО-00597", "comment": "ИО-00597", "price": "4675", "status": "done", "created_at": "2019-01-10", "paid_at": "2019-01-10", "items": { "name": "Информационное обслуживание за ООО \\\"Best Company\\\". Ежедневная проверка штрафов ГИБДД (11-50 ТС)", "price": "5500", "quantity": "1", "discount": "15", "tax": "0", "unit": "month", "total_price": "4675" }, "pdf_url": "https:\/\/s3-eu-west-1.amazonaws.com\/shtrafovnet\/payment\/invoices\/2017\/06\/12\/142338_20170612_invoice_*****.pdf" }