Skip to main content
Skip table of contents

Основные конфигурации клиентa

Основные конфигурации

Общая информация Запрос для получения основных настроек проекта.

Ключи intercom_call_events и external_events будут присутствовать в ответе, только при наличие доступа к данным свойствам у пользователя. Если для ключей latitude, longitude, zoom в секции map_coordinates приходят значения null, значит они небыли установленны

GET /api/v1/static

200 OK

Возвращает список доступной пользователю информации

JSON
{
    "notification": {
        "text": "Some notification",
        "is_force": true
    },
    "mark_types": [
        {
            "name": "mark",
            "description": "Метка"
        },
        {
            "name": "external_event",
            "description": "Внешние события"
        },
        {
            "name": "motion_detect_smtp",
            "description": "Детекция движения SMTP"
        },
        {
            "name": "face-recognized",
            "description": "Лицо идентифицировано"
        },
        {
            "name": "face-unrecognized",
            "description": "Лицо не идентифицировано"
        },
        {
            "name": "person-counting",
            "description": "Подсчет людей в области"
        },
        {
            "name": "motion_detect",
            "description": "Детекция вторжения в зону"
        },
        {
            "name": "licplate-recognized",
            "description": "Номерной знак идентифицирован"
        },
        {
            "name": "licplate-unrecognized",
            "description": "Номерной знак неидентифицирован"
        },
        {
            "name": "visitors-counting",
            "description": "Подсчет посетителей"
        },
        {
            "name": "camera-obstacle",
            "description": "Детекция повреждения"
        }
    ],
    "camera_issues": [
        {
            "id": 1,
            "title": "Посторонние предметы в объективе"
        },
        {
            "id": 2,
            "title": "Нет звука"
        },
        {
            "id": 3,
            "title": "Нет изображения"
        },
        {
            "id": 4,
            "title": "Перебои в работе"
        },
        {
            "id": 5,
            "title": "Неисправен поворотный механизм"
        }
    ],
    "analytic_issues": [
        {
            "id": 13,
            "title": "Не приходят события аналитики. Поток аналитики активен"
        },
        {
            "id": 14,
            "title": "Не приходят события аналитики. Поток аналитики неактивен"
        }
    ],
    "layout_templates": [
        {
            "id": 1,
            "name": "Grid11",
            "count": 1,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 2,
            "name": "Grid21",
            "count": 2,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 3,
            "name": "Grid22",
            "count": 2,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 4,
            "name": "Grid31",
            "count": 3,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 5,
            "name": "Grid41",
            "count": 4,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 6,
            "name": "Grid42",
            "count": 4,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 7,
            "name": "Grid51",
            "count": 5,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 8,
            "name": "Grid61",
            "count": 6,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 9,
            "name": "Grid62",
            "count": 6,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 10,
            "name": "Grid81",
            "count": 8,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 11,
            "name": "Grid91",
            "count": 9,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 12,
            "name": "Grid111",
            "count": 11,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        },
        {
            "id": 13,
            "name": "Grid161",
            "count": 16,
            "created_at": "2021-05-27 15:43:36",
            "updated_at": "2021-05-27 15:43:36"
        }
    ],
    "permissions": [
        {
            "type": "analytic",
            "external_key": "analytic_l3",
            "group": "Уровень аналитики 3",
            "permissions": [
                {
                    "id": 51,
                    "name": "analytic-cases-face",
                    "display_name": "Бизнес-кейс - распознавание лиц",
                    "group": "Бизнес-кейсы аналитики"
                },
                {
                    "id": 58,
                    "name": "analytic-cases-license-plate",
                    "display_name": "Бизнес-кейс - распознавание номерных знаков ",
                    "group": "Бизнес-кейсы аналитики"
                }
            ]
        },
        {
            "type": "analytic",
            "external_key": "analytic_l2",
            "group": "Уровень аналитики 2",
            "permissions": [
                {
                    "id": 52,
                    "name": "analytic-cases-person-counting",
                    "display_name": "Бизнес-кейс - подсчет людей в области",
                    "group": "Бизнес-кейсы аналитики"
                },
                {
                    "id": 59,
                    "name": "analytic-cases-visitor-counting",
                    "display_name": "Бизнес-кейс - подсчет посетителей",
                    "group": "Бизнес-кейсы аналитики"
                }
            ]
        },
        {
            "type": "analytic",
            "external_key": "analytic_l1",
            "group": "Уровень аналитики 1",
            "permissions": [
                {
                    "id": 62,
                    "name": "analytic-cases-smoke-fire",
                    "display_name": "Бизнес-кейс - детекция дыма и огня",
                    "group": "Бизнес-кейсы аналитики"
                },
                {
                    "id": 63,
                    "name": "analytic-cases-line-intersection",
                    "display_name": "Бизнес-кейс - детекция пересечения линии",
                    "group": "Бизнес-кейсы аналитики"
                },
                {
                    "id": 61,
                    "name": "analytic-cases-loud-sounds",
                    "display_name": "Бизнес-кейс - детекция громких звуков",
                    "group": "Бизнес-кейсы аналитики"
                },
                {
                    "id": 57,
                    "name": "analytic-cases-motion-detect",
                    "display_name": "Бизнес-кейс - детекция вторжения в зону",
                    "group": "Бизнес-кейсы аналитики"
                },
                {
                    "id": 60,
                    "name": "analytic-cases-camera-obstacle",
                    "display_name": "Бизнес-кейс - детекция повреждения / перекрытия / вандализма камеры",
                    "group": "Бизнес-кейсы аналитики"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Бизнес-кейсы аналитики",
            "permissions": [
                {
                    "id": 50,
                    "name": "analytic-cases-index",
                    "display_name": "Список бизнес-кейсов",
                    "group": "Бизнес-кейсы аналитики"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Ресурсы аналитики",
            "permissions": [
                {
                    "id": 43,
                    "name": "analytic-files-destroy",
                    "display_name": "Удаление ресурса"
                },
                {
                    "id": 39,
                    "name": "analytic-files-index",
                    "display_name": "Просмотр ресурсов"
                },
                {
                    "id": 41,
                    "name": "analytic-files-show",
                    "display_name": "Просмотр ресурса"
                },
                {
                    "id": 40,
                    "name": "analytic-files-store",
                    "display_name": "Создание ресурса"
                },
                {
                    "id": 42,
                    "name": "analytic-files-update",
                    "display_name": "Обновление ресурса"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Группы ресурсов аналитики",
            "permissions": [
                {
                    "id": 48,
                    "name": "analytic-groups-destroy",
                    "display_name": "Удаление группы ресурсов"
                },
                {
                    "id": 44,
                    "name": "analytic-groups-index",
                    "display_name": "Просмотр групп ресурсов"
                },
                {
                    "id": 46,
                    "name": "analytic-groups-show",
                    "display_name": "Просмотр группы ресурсов"
                },
                {
                    "id": 45,
                    "name": "analytic-groups-store",
                    "display_name": "Создание группы ресурсов"
                },
                {
                    "id": 47,
                    "name": "analytic-groups-update",
                    "display_name": "Обновление группы ресурсов"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Статистика лицензий",
            "permissions": [
                {
                    "id": 261,
                    "name": "analytic-license-index",
                    "display_name": "Статистика лицензий бизнес-кейсов"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Архив",
            "permissions": [
                {
                    "id": 19,
                    "name": "archives-download",
                    "display_name": "Сохранение архива камер"
                },
                {
                    "id": 18,
                    "name": "archives-show",
                    "display_name": "Просмотр архива"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Скриншоты",
            "permissions": [
                {
                    "id": 20,
                    "name": "archives-preview-download",
                    "display_name": "Сохранение скриншота камеры"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "События",
            "permissions": [
                {
                    "id": 22,
                    "name": "camera-events-index",
                    "display_name": "Просмотр событий камеры"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Группы камер",
            "permissions": [
                {
                    "id": 16,
                    "name": "groups-cameras-attach",
                    "display_name": "Добавление камеры в папку"
                },
                {
                    "id": 17,
                    "name": "groups-cameras-detach",
                    "display_name": "Удаление камеры из папки"
                },
                {
                    "id": 14,
                    "name": "groups-destroy",
                    "display_name": "Удаление папки"
                },
                {
                    "id": 15,
                    "name": "groups-rename",
                    "display_name": "Переименование папки"
                },
                {
                    "id": 13,
                    "name": "groups-store",
                    "display_name": "Создание папки"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Домофон",
            "permissions": [
                {
                    "id": 235,
                    "name": "intercom-index",
                    "display_name": "Отображение домофонов"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Раскладки",
            "permissions": [
                {
                    "id": 11,
                    "name": "layouts-cameras-attach",
                    "display_name": "Добавление камеры в раскладку"
                },
                {
                    "id": 12,
                    "name": "layouts-cameras-detach",
                    "display_name": "Удаление камер из раскладки"
                },
                {
                    "id": 9,
                    "name": "layouts-destroy",
                    "display_name": "Удаление раскладки"
                },
                {
                    "id": 10,
                    "name": "layouts-rename",
                    "display_name": "Переименование раскладки"
                },
                {
                    "id": 8,
                    "name": "layouts-store",
                    "display_name": "Создание раскладки"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Карты",
            "permissions": [
                {
                    "id": 38,
                    "name": "map-destroy",
                    "display_name": "Удаление карты"
                },
                {
                    "id": 34,
                    "name": "map-index",
                    "display_name": "Просмотр карт"
                },
                {
                    "id": 36,
                    "name": "map-show",
                    "display_name": "Просмотр карты"
                },
                {
                    "id": 35,
                    "name": "map-store",
                    "display_name": "Создание карты"
                },
                {
                    "id": 37,
                    "name": "map-update",
                    "display_name": "Обновление карты"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Метки",
            "permissions": [
                {
                    "id": 26,
                    "name": "marks-destroy",
                    "display_name": "Удаление меток"
                },
                {
                    "id": 23,
                    "name": "marks-index",
                    "display_name": "Просмотр меток"
                },
                {
                    "id": 24,
                    "name": "marks-store",
                    "display_name": "Создание меток"
                },
                {
                    "id": 25,
                    "name": "marks-update",
                    "display_name": "Обновление меток"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "PTZ",
            "permissions": [
                {
                    "id": 21,
                    "name": "ptz",
                    "display_name": "Управление PTZ"
                }
            ]
        },
        {
            "type": null,
            "external_key": null,
            "group": "Скрипты",
            "permissions": [
                {
                    "id": 33,
                    "name": "scripts-destroy",
                    "display_name": "Удаление скрипта"
                },
                {
                    "id": 29,
                    "name": "scripts-index",
                    "display_name": "Просмотр списка скриптов"
                },
                {
                    "id": 31,
                    "name": "scripts-show",
                    "display_name": "Просмотр скрипта"
                },
                {
                    "id": 30,
                    "name": "scripts-store",
                    "display_name": "Сохранение скрипта"
                },
                {
                    "id": 32,
                    "name": "scripts-update",
                    "display_name": "Обновление скрипта"
                }
            ]
        }
    ],
    "external_events": [
        {
            "id": 18,
            "name": "face-recognized",
            "description": "Лицо идентифицировано",
            "color": "#07D4F0",
            "analytic_type": "face"
        },
        {
            "id": 19,
            "name": "face-unrecognized",
            "description": "Лицо не идентифицировано",
            "color": "#91D4E2",
            "analytic_type": "face"
        },
        {
            "id": 41,
            "name": "person-counting",
            "description": "Подсчет людей в области",
            "color": "#FF7CF2",
            "analytic_type": "person-counting"
        },
        {
            "id": 28,
            "name": "motion_detect",
            "description": "Детекция вторжения в зону",
            "color": "#5AD057",
            "analytic_type": "motion_detect"
        },
        {
            "id": 20,
            "name": "licplate-recognized",
            "description": "Номер идентифицирован",
            "color": "#3EDE9B",
            "analytic_type": "licplate-recognition"
        },
        {
            "id": 21,
            "name": "licplate-unrecognized",
            "description": "Номер не идентифицирован",
            "color": "#628BFF",
            "analytic_type": "licplate-recognition"
        },
        {
            "id": 27,
            "name": "visitors-counting",
            "description": "Детекция посетителей",
            "color": "#8B3EBA",
            "analytic_type": "visitors-counting"
        },
        {
            "id": 33,
            "name": "camera-obstacle",
            "description": "Детекция повреждения / перекрытия / вандализма камеры",
            "color": "#2542DF",
            "analytic_type": "camera-obstacle"
        }
    ],
    "system_events": [
        {
            "name": "stream_high_active",
            "title": "Стрим высокого качества активен"
        },
        {
            "name": "stream_high_inactive",
            "title": "Стрим высокого качества неактивен"
        },
        {
            "name": "stream_low_active",
            "title": "Стрим низкого качества активен"
        },
        {
            "name": "stream_low_inactive",
            "title": "Стрим низкого качества неактивен"
        }
    ],
    "camera_events": [
        {
            "name": "motion_detect_smtp",
            "description": "Детекция движения SMTP"
        }
    ],
    "video_rates": [
        1,
        5,
        10
    ],
    "event_reactions": [
        {
            "id": 2,
            "name": "set-mark",
            "description": "Установить метку",
            "is_default": false
        },
        {
            "id": 4,
            "name": "show-camera",
            "description": "Открыть камеру",
            "is_default": false
        },
        {
            "id": 7,
            "name": "telegram-message",
            "description": "Отправить сообщение в telegram",
            "is_default": false
        },
        {
            "id": 8,
            "name": "show-camera-sidebar",
            "description": "Отразить событие в Сайдбаре",
            "is_default": false
        },
        {
            "id": 9,
            "name": "sound",
            "description": "Звуковое уведомление",
            "is_default": false
        },
        {
            "id": 10,
            "name": "without-reaction",
            "description": "Без реакции",
            "is_default": true
        }
    ],
    "analytic_files_types": [
        {
            "name": "face_resource",
            "description": "Лица"
        },
        {
            "name": "plate_resource",
            "description": "Номера автомобилей"
        }
    ],
    "analytic_case_camera_status": [
        {
            "name": "processed",
            "description": "Активна"
        },
        {
            "name": "unprocessed",
            "description": "Неактивна"
        }
    ],
    "analytic_case_status": [
        {
            "name": "active",
            "description": "Активна"
        },
        {
            "name": "inactive",
            "description": "Неактивна"
        }
    ],
    "intercom_end_call": "60",
    "analytic_license": [
        {
            "type": "analytic_l1",
            "data": [
                {
                    "type": "loud-sound-detection",
                    "permission": "analytic-cases-loud-sounds"
                },
                {
                    "type": "smoke-fire",
                    "permission": "analytic-cases-smoke-fire"
                },
                {
                    "type": "line-intersection",
                    "permission": "analytic-cases-line-intersection"
                },
                {
                    "type": "camera-obstacle",
                    "permission": "analytic-cases-camera-obstacle"
                },
                {
                    "type": "motion_detect",
                    "permission": "analytic-cases-motion-detect"
                }
            ]
        },
        {
            "type": "analytic_l2",
            "data": [
                {
                    "type": "person-counting",
                    "permission": "analytic-cases-person-counting"
                },
                {
                    "type": "visitors-counting",
                    "permission": "analytic-cases-visitor-counting"
                }
            ]
        },
        {
            "type": "analytic_l3",
            "data": [
                {
                    "type": "face",
                    "permission": "analytic-cases-face"
                },
                {
                    "type": "licplate-recognition",
                    "permission": "analytic-cases-license-plate"
                }
            ]
        }
    ],
    "visitor_counter_filters": {
        "steps": [
            {
                "name": "minute",
                "description": "Минута"
            },
            {
                "name": "hour",
                "description": "Час"
            },
            {
                "name": "day",
                "description": "День"
            }
        ],
        "sexes": [
            {
                "name": "male",
                "description": "Мужской"
            },
            {
                "name": "female",
                "description": "Женский"
            }
        ],
        "ages": [
            {
                "name": "under_18_years",
                "description": "До 18 лет"
            },
            {
                "name": "18_30_years",
                "description": "18-30 лет"
            },
            {
                "name": "30_45_years",
                "description": "30-45 лет"
            },
            {
                "name": "45_60_years",
                "description": "45-60 лет"
            },
            {
                "name": "over_60_years",
                "description": "60+ лет"
            }
        ]
    },
    "analytic_events": [
        {
            "id": 18,
            "name": "face-recognized",
            "title": "Лицо идентифицировано",
            "color": "#07D4F0",
            "analytic_type": "face"
        },
        {
            "id": 19,
            "name": "face-unrecognized",
            "title": "Лицо не идентифицировано",
            "color": "#91D4E2",
            "analytic_type": "face"
        },
        {
            "id": 41,
            "name": "person-counting",
            "title": "Подсчет людей в области",
            "color": "#FF7CF2",
            "analytic_type": "person-counting"
        },
        {
            "id": 28,
            "name": "motion_detect",
            "title": "Детекция вторжения в зону",
            "color": "#5AD057",
            "analytic_type": "motion_detect"
        },
        {
            "id": 20,
            "name": "licplate-recognized",
            "title": "Номер идентифицирован",
            "color": "#3EDE9B",
            "analytic_type": "licplate-recognition"
        },
        {
            "id": 21,
            "name": "licplate-unrecognized",
            "title": "Номер не идентифицирован",
            "color": "#628BFF",
            "analytic_type": "licplate-recognition"
        },
        {
            "id": 27,
            "name": "visitors-counting",
            "title": "Детекция посетителей",
            "color": "#8B3EBA",
            "analytic_type": "visitors-counting"
        },
        {
            "id": 33,
            "name": "camera-obstacle",
            "title": "Детекция повреждения / перекрытия / вандализма камеры",
            "color": "#2542DF",
            "analytic_type": "camera-obstacle"
        }
    ],
    "analytic_cases": [
        {
            "name": "face",
            "description": "Распознавание лиц",
            "fields": {
                "threshold": 50
            }
        },
        {
            "name": "person-counting",
            "description": "Подсчет людей в области",
            "fields": {
                "reaction_after_value": 10
            }
        },
        {
            "name": "motion_detect",
            "description": "Детекция вторжения в зону"
        },
        {
            "name": "licplate-recognition",
            "description": "Распознавание номерных знаков"
        },
        {
            "name": "visitors-counting",
            "description": "Подсчет посетителей"
        },
        {
            "name": "camera-obstacle",
            "description": "Детекция повреждения / перекрытия / вандализма камеры"
        }
    ],
    "bridge_events": [
        {
            "name": "user.bridge.activated",
            "description": "Бридж активирован."
        },
        {
            "name": "user.bridge.deactivated",
            "description": "Бридж деактивирован"
        }
    ],
    "logos": {
        "dark": [
            {
                "id": 243,
                "type": "smart_banner_client",
                "title": "Smart banner client",
                "description": "Smart banner icon for mobile applications in mobile browser versions for iOS and Android OS",
                "url": "http://127.0.0.1:8000/storage/favicons/client/smart-banner.png",
                "version": 1
            },
            {
                "id": 257,
                "type": "login",
                "title": "Authorization page",
                "description": "Product logo on web client and admin login page",
                "url": "http://127.0.0.1:8000/storage/logos/dark/en/login.svg",
                "version": 1
            },
            {
                "id": 261,
                "type": "client_header",
                "title": "Web client",
                "description": "The logo is located in the web client on the top panel of the interface",
                "url": "http://127.0.0.1:8000/storage/logos/dark/en/client_header.svg",
                "version": 1
            }
        ],
        "light": [
            {
                "id": 243,
                "type": "smart_banner_client",
                "title": "Smart banner client",
                "description": "Smart banner icon for mobile applications in mobile browser versions for iOS and Android OS",
                "url": "http://127.0.0.1:8000/storage/favicons/client/smart-banner.png",
                "version": 1
            },
            {
                "id": 263,
                "type": "login",
                "title": "Authorization page",
                "description": "Product logo on web client and admin login page",
                "url": "http://127.0.0.1:8000/storage/logos/light/en/login.svg",
                "version": 1
            },
            {
                "id": 267,
                "type": "client_header",
                "title": "Web client",
                "description": "The logo is located in the web client on the top panel of the interface",
                "url": "http://127.0.0.1:8000/storage/logos/light/en/client_header.svg",
                "version": 1
            }
        ]
    },
    "qr": "schema://connection/somedata",
    "is_need_to_show_subuser_popup": true,
    "analytic_case_camera_user_status": [
        {
            "name": "failed_to_create",
            "description": "Ошибка создания",
            "text": "Не удалось создать камеру. Повторите попытку позже"
        },
        {
            "name": "failed_to_update",
            "description": "Ошибка обновления",
            "text": "Не удалось обновить камеру. Повторите попытку позже"
        },
        {
            "name": "failed_to_delete",
            "description": "Ошибка удаления",
            "text": "Не удалось удалить камеру. Повторите попытку позже."
        }
    ],
    "camera_status": [
        {
            "name": "active",
            "description": "Active"
        },
        {
            "name": "inactive",
            "description": "Inactive"
        },
        {
            "name": "partial",
            "description": "Partially active"
        },
        {
            "name": "blocked",
            "description": "Blocked"
        }
    ],
    "map_cameras_limit": 16,
    "maps_tree_max_depth": "5",
    "intercom_call_events": [
        {
            "name": "missed_intercom_call",
            "title": "Пропущенный вызов с домофона"
        },
        {
            "name": "answered_intercom_call",
            "title": "Принятый вызов с домофона"
        }
    ],
    "map_coordinates": {
        "latitude": 10.9,
        "longitude": 10.9,
        "zoom": 13
    }
}

401 Unauthorized

Токен авторизации не передан или не валидный

cURL
BASH
curl -k --request POST \
	--url 'https://your-domain/api/v1/static' \
	--header 'Content-Type: application/json' \
	--header 'Accept: application/json' \
	--data '[]'
PHP
PHP
$data = array (
);
$context = stream_context_create([
	'ssl'=>['verify_peer' => false],
	'http' => [
		'method' => 'GET',
		'header' => "Content-Type: application/json\r
Accept: application/json",
		'content'=>json_encode($data)
	]
]);
$result = file_get_contents('https://your-domain/api/v1/static', false, $context);
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.