Интеграция с трекингом (API)
Версия 3.1 от Григорий Лепёшкин на 2023/12/21 11:50
Назначение API
Веб-сервис для интеграции систем авторизованных сервисных центров (АСЦ) с системой провайдера. Веб-сервис позволяет передавать и получать данные по ремонту/трекингу, а также загружать вложения.
Список методов
- CreateTrackingCallCentr - Создание трекинга колл-центра.
- DeleteAttachment -Удаляет вложение трекинга по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения
- GetANRPInfo - Получение информации по акту неремонтопригодности.
- GetATOInfo - Получение информации по акту технического освидетельствования.
- GetActionPlace - Возвращает справочник мест ремонта.
- GetAttachment - Возвращает вложение по номеру ремонта АСЦ (OrderNumAsc) и по типу вложения.
- GetAttachmentKeys - Возвращает список вложений по системному номеру трекинга (OrderNum) без самих вложений.
- GetAttachmentTypes - Возвращает список типов вложений
- GetBrands - Возвращает список брендов в разрезе групп брендов.
- GetCategIrisConditionCodes - Возвращает справочник Iris Код условий по бренду и категории модели.
- GetCategIrisDefectCodes - Возвращает справочник Iris Код дефектов по бренду и категории модели.
- GetCategIrisRepairCodes - Возвращает справочник Iris Код ремонтов по бренду и категории модели.
- GetCategIrisSectionCodes - Возвращает справочник Iris Код секций по бренду и категории модели.
- GetCategIrisSymptomCodes - Возвращает справочник Iris Код симптомов по бренду и категории модели.
- GetIrisCodes - Возвращает Iris коды в разрезе типов Iris кодов (ConditionCode, DefectCode, RepairCode, sectionCode, SymptomCode), категорий моделей и брендов (в рамках активных авторизаций по брендам)
- GetModelCategories - Возвращает справочник категорий моделей.
- GetOrderByAscKey - Возвращает трекинг по номеру ремонта АСЦ (OrderNumAsc)
- GetOrderBySysKey - Возвращает трекинг по системному номеру (OrderNum).
- GetOrderKeys - Возвращает список трекингов, перешедших в конечный статус в последние 35 дней и всех остальных, не перешедших в конечный статус.
- GetRejectReasons - Список причин отмены трекинга
- GetSpRepairTypes - Возвращает справочник типов ремонтов по группе брендов (MainBrandUid).
- GetSpStatuses - Возвращает список статусов трекинга.
- GetTicket - Получение бинарного идентификатора для аутентификации пользователя по логину и паролю.
- GetTransportService - Возвращает справочник типов транспортировки по мету ремонта и бренду.
- GetTransportZone - Возврат справочника зон транспортировки.
- SaveAttachment - Создание вложения определенного типа в трекинге, с удалением всех вложений того же типа
- SaveOrder - Создание/обновление трекинга.
Порядок вызова методов и работы с сервисом
- Для начала работы требуется аутентифицироваться. Для этого нужно вызвать метод GetTicket с параметрами login и password и получить в ответ ticket. Он используются для вызова других методов сервиса. В качестве пользователя может использоваться любой созданный на сайте аккаунт с доступом к созданию трекинга.
- Далее нужно заполнить справочники (классификаторы) вашего сервиса, чтобы передавать их в метод сохранения ремонта. Справочники заполняются вызовами соответствующих методов класса «Получение классификатора».
- Ремонт создаётся методом SaveOrder. Любые изменения вносятся повторным вызовом этого метода. Метод возвращает в числе других параметров TrackingUid, необходим при сохранении вложений к трекингу SaveAttachment, получении информации по акту неремонтопригодности GetANRPInfo или акту технического освидетельствования GetATOInfo. Все детали (запчасти, з/ч) нужно передавать каждый раз при вызове метода.
- Важно:
- Ремонт в статусе «ОТЧЕТ», «ОТМЕНЁН», «ОПЛАЧЕН» не может быть обновлён.
- Ремонт в статусе «Ремонт начат» блокируется на изменение ряда полей:
- ReceiveDate - Дата приёма в ремонт
- Model - Модель
- SerialNumb - Серийный номер
- DesRepair - Заявленный дефект
- OrderNumBrand - Номер заявки ИЦ
- RepairTypeCurrent - Тип ремонта
То есть при передачи новых данных по этим полям, они будут проигнорированы.
Метод GetTicket
Получение бинарного идентификатора для аутентификации пользователя.
Входные параметры:
| Название параметра | Тип параметра | Обязательный | Описание параметра | Пример |
| Login | string | Да | Логин пользователя | Vasya |
| Password | string | Да | Пароль пользователя | 123456 |
Возвращаемое значение:
| Тип параметра | Описание параметра | Пример |
| string | Сессионный ключ | YOB7IG8UG687068 |