Программные интерфейсы (API)

SupportService API

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

 

Протокол: SOAP, WebService

Ссылка: http://<host>/api/supportservice

WSDL описание (document/literal): http://<host>/api/supportservice?wsdl

WSDL описание (rpc/encoded): http://<host>/api/supportservice?wsdl&style=rpc&use=encoded

 

Методы

НазваниеВозвращаемое значениеНазначение

RaiseIssue (string token.Key, request issue)

request

Создание пожелания с параметрами, заданными в качестве значений атрибутов переменной issue.

AttachFile (string token.Key, request issue, attachment file)

attachment

Прикрепляет файл к пожеланию, идентифицируемому полем issue.Id. Атрибуты файла, равно как и тело файла содержится в значениях переменной file.

 

Классы

НазваниеАтрибутНазначение

Request

Id

Идентификатор объекта

Caption

Название пожелания/ошибки

Description

Описание пожелания/ошибки

Attachment

Id

Идентификатор объекта

FilePath

Название файла, которое будет отображаться в проекте

FileExt

MIME-тип файла

File

Текстовое поле типа base64binary, содержащее тело файла в кодировке base64

 

Примеры (C#)
 // авторизуемся в проекте
 security.SecurityService api = new security.SecurityService() { 
      Url = 'http://<host>/api/securityservice'
 };
 support.SupportService _supportService = new support.SupportService() { 
      Url = 'http://<host>/api/securityservice'
 };
 
 security.Token _token = api.login("guest", "guest", "development");
 
 var issue = new support.request() {
     Caption = "Краткое описание ошибки",
     Description = "Подробное описание ошибки"
 };
 
 issue = _supportService.RaiseIssue(_token.Key, issue);
 
 // загружаем файл, например, дамп
 string fileName = Environment.GetEnvironmentVariable("windir") + "\\notepad.exe";
 FileStream fs = File.Open(fileName, FileMode.Open, FileAccess.Read);
 
 byte[] fileBytes = new byte[fs.Length];
 fs.Read(fileBytes, 0, (int)fs.Length);
 fs.Close();
 
 support.attachment file = support.attachment
 {
     FilePath = "notepad.exe",
     FileExt = (new FileInfo(fileName)).Extension,
     File = fileBytes
 };
 
 _supportService.AttachFile(_token.Key, issue, file);

Далее:

DataService API

Пример использования SOAP API на C#

Пример использования SOAP API на PHP