Back to top

API 1С:ГРМ для Партнеров 1С

Клиентское API предназначено для взаимодействия Партнера с облачной системой 1С:ГРМ в рамках участия в программе White Label. Взаимодействие выполняется путем формирования и отправки сообщений запроса в установленном формате по протоколу HTTPS.

Каждое сообщение запроса, отправляемое в систему 1С:ГРМ, обязано содержать уникальный 64-разрядный ключ, однозначно идентифицирующий Партнера с системе.

X-Auth-Token: ключ, полученный в кабинете Партнера 1С:ГРМ

Для получения ключа Партнер должен обратиться к Личному Кабинету. Обмен сообщениями между Партнером и системой 1С:ГРМ выполняется по протоколу HTTPS.

При выполнении вызова к системе 1С:ГРМ обработка сообщения запроса может быть выполнено успешно или завершиться с ошибкой. Признаком успешности выполнения запроса является наличие в сообщении ответа параметра Status=OK и коды ответа HTTP из диапозона 200-299. В том случае, когда обработка запроса завершилась неуспешно, сообщение ответа будет включать в себя параметр Status=ERROR и коды ответа HTTP из диапозонов 400-499 и 500-599, при этом в секции errors будет указана дополнительная информация об ошибке - тип, код, описание.

Управление конфигурациями и версиями платформы.

Конфигурации

Получить список конфигураций 1С
GET/meta/configurations

Метод возвращает список конфигураций 1С, доступных для публикации приложений 1С.

Example URI

GET https://api.1capp.com/v1/meta/configurations
Request  JSON Configuration Collection
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": [
    {
      "id": "32-char-uuid",
      "name": "Название конфигурации 1С",
      "description": "Описание"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "    Системная ошибка при выполнении запроса"
    }
  ]
}

Получить информацию о конфигурации 1С
GET/meta/configurations/{configuration_id}

Метод возвращает информацию о зарегистрированной в 1С:ГРМ конфигурации 1С.

Example URI

GET https://api.1capp.com/v1/meta/configurations/configuration_id
URI Parameters
HideShow
configuration_id
string (required) 

Уникальный идентификатор конфигурации

Request  JSON Configuration Object
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": [
    {
      "id": "8a80808550237dee015023fee7e7000d",
      "name": "3.0.42.25",
      "version": "3.0.42.25"
    },
    {
      "id": "8a80808550413f2301507f6d7ee60022",
      "name": "3.0.42.37",
      "version": "3.0.42.37"
    },
    {
      "id": "8a808085508f28b201508f3638440001",
      "name": "3.0.42.45",
      "version": "3.0.42.45"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "    Системная ошибка при выполнении запроса"
    }
  ]
}

Получить список версий платформы 1С

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

GET/meta/platormVersions

Example URI

GET https://api.1capp.com/v1/meta/platormVersions
Request  JSON Configuration Version Object Collection
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": [
    {
      "id": "8a80808550237dee015023efeac00004",
      "version": "8.3.6.2237",
      "name": "8.3.6.2237"
    },
    {
      "id": "8a80808550237dee015023f023250005",
      "version": "8.3.6.2299",
      "name": "8.3.6.2299"
    },
    {
      "id": "8a80808550413f2301507f8e968d0028",
      "version": "8.3.6.2332",
      "name": "8.3.6.2332"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "    Системная ошибка при выполнении запроса"
    }
  ]
}

Управление клиентами Партнера 1С:ГРМ

Клиенты

Получить список клиентов
GET/customers

Метод предназначен для получения списка клиентов Партнера, зарегистрированных Партнером в системе 1С:ГРМ.

Example URI

GET https://api.1capp.com/v1/customers
Request  JSON Customer Object Collection
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": [
    {
      "id": "40288082532e8567015330f4ee170214",
      "phone": "81234567890",
      "email": "email@example.com",
      "responsibleName": "Иванов"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "    Системная ошибка при выполнении запроса"
    }
  ]
}

Найти клиента по ИНН и КПП
GET/customers{?inn,kpp}

Метод предназначен выполнения поиска и получении информации о клиенте Партнера по ИНН и КПП.

Example URI

GET https://api.1capp.com/v1/customers?inn=&kpp=
URI Parameters
HideShow
inn
number (required) 

ИНН клиента.

kpp
number (optional) Default: null 

КПП клиента (необязательный параметр).

Request  JSON Customer Object
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532e8567015330f4ee170214",
    "phone": "81234567890",
    "email": "email@example.com",
    "responsibleName": "Иванов"
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_004",
      "message": "Клиентская организация по заданным параметрам не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "    Системная ошибка при выполнении запроса"
    }
  ]
}

Найти клиента по Email
GET/customers{?email}

Метод предназначен для выполнения поиска и получении информации о клиенте Партнера по адресу электронной почты.

Example URI

GET https://api.1capp.com/v1/customers?email=
URI Parameters
HideShow
email
string (required) 

Адрес электронной почты клиента.

Request  JSON Customer Object
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532e8567015330f4ee170214",
    "phone": "81234567890",
    "email": "email@example.com",
    "responsibleName": "Иванов"
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_004",
      "message": "Клиентская организация по заданным параметрам не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Получить информацию о клиенте
GET/customers/{customerId}

Метод предназначен для выполнения поиска и получении информации о клиенте Партнера по его уникальному идентификатору в системе 1С:ГРМ.

Example URI

GET https://api.1capp.com/v1/customers/customerId
URI Parameters
HideShow
customerId
string (required) 

Уникальный идентификатор клиента Партнера в системе 1С:ГРМ.

Request  JSON Customer Object
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532e8567015330f4ee170214",
    "phone": "81234567890",
    "email": "email@example.com",
    "responsibleName": "Иванов"
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_004",
      "message": "Клиентская организация по заданным параметрам не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Зарегистрировать клиента
POST/customers

Метод предназначен для добавления минимально необходимых данных о клиенте Партнера в 1С:ГРМ.

Example URI

POST https://api.1capp.com/v1/customers
Request  JSON Customer Demo App Object
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532e8567015332b0e6db014d",
    "phone": "123456789",
    "email": "email19@email.comom",
    "responsibleName": "Тестович"
  }
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "32-char-uuid",
  "responsibleName": "Иванов Иван",
  "email": "example@example.com",
  "phone": "+79998339017"
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_010",
      "message": "Пользователь с таким Email уже зарегистрирован"
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_003",
      "message": "Неверно оформлен запрос"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Демо

Получить список демонстрационных приложений
GET/customer/{customerId}/demos

Метод предназначен для получения списка демонстрационных приложений клиента Партнера.

Example URI

GET https://api.1capp.com/v1/customer/customerId/demos
URI Parameters
HideShow
customerId
string (required) 

уникальный идентификатор клиента Партнера 1С:ГРМ.

Request
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": [
    {
      "customerId": "4028808251a0e7300151a0ec36599002",
      "licenseCount": 1,
      "startDate": 1456464810923,
      "applicationId": "402880825313d45901531c1153ac0270"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_004",
      "message": "Клиентская организация по заданным параметрам не найдена"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Создать демонстрационное приложение пользователя
POST/customer/{customerId}/demos

Метод предназначен для создания демонстрационного приложения клиента Партнера.

Example URI

POST https://api.1capp.com/v1/customer/customerId/demos
URI Parameters
HideShow
customerId
string (required) 

уникальный идентификатор клиента Партнера 1С:ГРМ.

Request
HideShow
Headers
Content-Type: application/json
X-Auth-Token: _secret_64char_api_key_
Body
{
  "configurationVersionId": "8a89808552eebb3a0153185b0aac0038",
  "platformVersionId": "8a80808552eebb3a0153185beebc003a",
  "customerId": "402880825165e7300151a0ec36590002",
  "licenseCount": 1,
  "name": "Унф ООО Ветерок",
  "contextPath": "unf-veterok"
}
Response  201
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "customerId": "4028808251a0e7300151a0ec36599002",
    "licenseCount": 1,
    "startDate": 1456464810923,
    "applicationId": "402880825313d45901531c1153ac0270"
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_003",
      "message": "Неверно оформлен запрос"
    }
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_004",
      "message": "Клиентская организация по заданным параметрам не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Управление приложениями 1С:ГРМ

АПИ для управления состоянием приложений в 1С:ГРМ.

Приложения 1С

Получить список приложений Партнера
GET/applications

Метод предназначен для получения от системы 1С:ГРМ списка приложений Партнера.

Example URI

GET https://api.1capp.com/v1/applications
Request  ECW IB JSON object Collection
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": [
    {
      "id": "40288082532c578601532cd9d47b0003",
      "name": "test",
      "status": "stopped",
      "type": "prod",
      "licenseCount": 5,
      "url": "app768629.1capp.net/test",
      "configurationVersionId": "8a80808552ac86950152c07efedc0514",
      "platformVersionId": "8a80808552ac86950152c685d6190019"
    },
    {
      "id": "40288082510f56eb01511068bbcd0019",
      "name": "1C:Бухгалтерия 8 ПРОФ",
      "status": "running",
      "type": "prod",
      "licenseCount": 3,
      "url": "app755386.1capp.net/1CBukhgalteriya_8_PROF",
      "configurationVersionId": "8a8080855045656201510ebd6e81001b",
      "platformVersionId": "8a808085523ee208015255714ba50024"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Получить информацию о приложении
GET/applications/{id}

Метод предназначен для получения от системы 1С:ГРМ информации о приложении 1С.

Example URI

GET https://api.1capp.com/v1/applications/id
URI Parameters
HideShow
id
string (required) 

уникальный идентификатор ИБ ГРМ

Request  ECW IB JSON object Data
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532c578601532cdcd47b0003",
    "name": "test",
    "status": "stopped",
    "type": "prod",
    "licenseCount": 5,
    "url": "app718699.1capp.net/test",
    "configurationVersionId": "8a80508552ac86950152c07efedc0014",
    "platformVersionId": "8a80804562ac86950152c085d6190019"
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_006",
      "message": "Приложение с указанным идентификатором не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Остановить приложение
PATCH/applications/{id}

Метод предназначен для отправки в 1С:ГРМ запроса на выполнение остановки приложения.

Example URI

PATCH https://api.1capp.com/v1/applications/id
URI Parameters
HideShow
id
string (required) 

уникальный Id ИБ ГРМ

Request  ECW IB JSON object Data
HideShow
Headers
Content-Type: application/json
X-Auth-Token: _secret_64char_api_key_
Body
{
  "status": "stop"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532c578901532cdcd47b0003",
    "name": "test",
    "status": "stopping",
    "type": "prod",
    "licenseCount": 5,
    "url": "app718729.1capp.net/test",
    "configurationVersionId": "8a80808552ac86950152c97efedc0014",
    "platformVersionId": "8a80808562ac86950152c085d6190019"
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_006",
      "message": "Приложение с указанным идентификатором не найдена"
    }
  ]
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_009",
      "message": "Приложение занято выполнением другого запроса"
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_003",
      "message": "Неверно оформлен запрос"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Запустить приложение
PATCH/applications/{id}

Метод предназначен для отправки в 1С:ГРМ запроса на выполнения запуска приложения.

Example URI

PATCH https://api.1capp.com/v1/applications/id
URI Parameters
HideShow
id
string (required) 

уникальный Id ИБ ГРМ

Request  ECW IB JSON object Data
HideShow
Headers
Content-Type: application/json
X-Auth-Token: _secret_64char_api_key_
Body
{
  "status": "start"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532c578901532cdcd47b0003",
    "name": "test",
    "status": "starting",
    "type": "prod",
    "licenseCount": 5,
    "url": "app718729.1capp.net/test",
    "configurationVersionId": "8a80808552ac86950152c97efedc0014",
    "platformVersionId": "8a80808562ac86950152c085d6190019"
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_006",
      "message": "Приложение с указанным идентификатором не найдена"
    }
  ]
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_009",
      "message": "Приложение занято выполнением другого запроса"
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_003",
      "message": "Неверно оформлен запрос"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Установить количество лицензий
PATCH/applications/{id}

Метод предназначен для отправки запроса в 1С:ГРМ на выполнения задачи изменения количества лицензий приложения.

Example URI

PATCH https://api.1capp.com/v1/applications/id
URI Parameters
HideShow
id
string (required) 

уникальный Id ИБ ГРМ

Request  ECW IB JSON object Data
HideShow
Headers
Content-Type: application/json
X-Auth-Token: _secret_64char_api_key_
Body
{
  "licenseCount": 4
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532c578901532cdcd47b0003",
    "name": "test",
    "status": "configuring",
    "type": "prod",
    "licenseCount": 5,
    "url": "app718729.1capp.net/test",
    "configurationVersionId": "8a80808552ac86950152c97efedc0014",
    "platformVersionId": "8a80808562ac86950152c085d6190019"
  }
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_009",
      "message": "Приложение занято выполнением другого запроса"
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_003",
      "message": "Неверно оформлен запрос"
    }
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_006",
      "message": "Приложение с указанным идентификатором не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Изменить версию платформы
PATCH/applications/{id}

Метод предназначен для отправки запроса в 1С:ГРМ на выполнения задачи изменения версии приложения.

Example URI

PATCH https://api.1capp.com/v1/applications/id
URI Parameters
HideShow
id
string (required) 

уникальный Id ИБ ГРМ

Request  ECW IB JSON object Data
HideShow
Headers
Content-Type: application/json
X-Auth-Token: _secret_64char_api_key_
Body
{
  "platformVersionId": "unique-32char-platform-version-id"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532c578901532cdcd47b0003",
    "name": "test",
    "status": "configuring",
    "type": "prod",
    "licenseCount": 5,
    "url": "app718729.1capp.net/test",
    "configurationVersionId": "8a80808552ac86950152c97efedc0014",
    "platformVersionId": "8a80808562ac86950152c085d6190019"
  }
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_009",
      "message": "Приложение занято выполнением другого запроса"
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_003",
      "message": "Неверно оформлен запрос"
    }
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_006",
      "message": "Приложение с указанным идентификатором не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Удалить приложение
DELETE/applications/{id}{?postpone}

Метод предназначен для отправки запроса в 1С:ГРМ на выполнения задачи удаления приложения.

Example URI

DELETE https://api.1capp.com/v1/applications/id?postpone=
URI Parameters
HideShow
id
string (required) 

Уникальный id ИБ ГРМ.

postpone
number (optional) 

Количество дней, через которое удалить ИБ. 0 - удалить немедленно. 7 - максимальное число дней. По-умолчанию ИБ удаляются через 1 день.

Default
string (required) Example: 1
Request
HideShow
Headers
X-Auth-Token: _secret_64char_api_key_
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "OK",
  "data": {
    "id": "40288082532c578651532cdcd47b0003",
    "name": "test",
    "status": "running",
    "type": "prod",
    "licenseCount": 5,
    "url": "app716629.1capp.net/test",
    "scheduledDeleteDate": 1456910056097,
    "configurationVersionId": "8a80808352ac86950152c07efedc0014",
    "platformVersionId": "8a80858552eebb3a0153185beebc003a"
  }
}
Response  409
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_009",
      "message": "Приложение занято выполнением другого запроса"
    }
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_003",
      "message": "Неверно оформлен запрос"
    }
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_006",
      "message": "Приложение с указанным идентификатором не найдена"
    }
  ]
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "APP_ERROR",
      "code": "APP_ERROR_001",
      "message": "Неверный ключ авторизации"
    }
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ERROR",
  "errors": [
    {
      "type": "SYS_ERROR",
      "code": "SYS_ERROR_001",
      "message": "Системная ошибка при выполнении запроса"
    }
  ]
}

Generated by aglio on 19 Sep 2018