Цифра ↔ 1С

check — Проверка наличия заданий

Метод для регулярной проверки на наличие новых заданий. Рекомендовано отправлять 1 раз в минуту.

Запрос

POST /api/check

Параметры запроса

Параметр Тип Обязательный Описание
SecretKey string Да Секретный ключ из настроек Цифры

Пример запроса

{
  "SecretKey": "2akgzOCYsAxLwpNl"
}

Пример curl:

curl -X POST https://1c.cifra.ai/api/check \
  -H "Content-Type: application/json" \
  -d '{"SecretKey":"2akgzOCYsAxLwpNl"}'

Ответ

Успешный ответ (200)

Поле Тип Обязательное Описание
Tasks array Да Массив заданий
Tasks[].Id integer Да Идентификатор задания
Tasks[].Task string Да Название задания (getCars, createApplication, и т.д.)
Tasks[].Status string Да Текущий статус задания (new, work, done, failed)
Tasks[].Params object Нет Параметры задания (зависят от типа задания)

Пример ответа

{
  "Tasks": [
    {
      "Id": 15,
      "Task": "getCars",
      "Status": "new",
      "Params": null
    },
    {
      "Id": 16,
      "Task": "createApplication",
      "Status": "new",
      "Params": {
        "Date": "2024-12-12 14:30:00",
        "Client": {
          "Id": 123,
          "Guid": "22db4291-154f-11ec-973e-244bfecb4e0a",
          "Name": "ООО Заказчик",
          "Inn": "7604377806"
        },
        "Recipe": {
          "Id": 45,
          "Guid": "33ab5192-265g-22fc-a84f-355cgfdc5f1b",
          "Name": "БСТ В25П4F200",
          "Price": 4500
        },
        "Total": 12
      }
    }
  ]
}

Коды ответов

Код Описание
200 Успешно. Возвращается список заданий (может быть пустым)
403 Секретный ключ не найден

Примечания

Типы заданий

Получение данных из 1С

Создание сущностей в 1С

См. также