diff --git a/openapi.yaml b/openapi.yaml index dd6ded6..2e19f37 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -64,7 +64,7 @@ paths: /webhook/delete: get: description: это метод для оповещения об удалении итеграции из учетки в амо. При его вызове надо мягко удалить соответствующий аккаунт. https://www.amocrm.ru/developers/content/oauth/step-by-step#%D0%A5%D1%83%D0%BA-%D0%BE%D0%B1-%D0%BE%D1%82%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B8-%D0%B8%D0%BD%D1%82%D0%B5%D0%B3%D1%80%D0%B0%D1%86%D0%B8%D0%B8 - /utms: + /utms/{quizID}: get: description: получение списка заданных юзером utm меток. Это чисто наша сущность, в амо она представлена кастомными полями сделки parameters: @@ -239,13 +239,80 @@ paths: /rules/{quizID}: get: description: получение настроек интеграции для конкретного квиза + responses: + '200': + description: успешное получение настройки интеграции + content: + 'application/json': + schema: + $ref: "#/components/schemas/Rule" post: - description: создание настроек интеграции для конкретного квиза + description: создание настроек интеграции для конкретного квиза. заполнишь сам? тут просто передача всех данных, что можно получить от этого запроса, кроме айдишников, которые генерятся, флага удаления, времени создания и айдишников, получаемых из токена patch: description: изменение настроек интеграции для конкретного квиза components: schemas: + Rule: + type: object + description: объект настройки правил сохранения данных в амо + properties: + ID: + type: integer + description: айдишник в нашей системе + AccountID: + type: string + description: связь с аккаунтом в интеграции амо + QuizID: + type: integer + description: айдишник опроса + PerformerID: + type: integer + description: айдишник ответственного за сделку + PipelineID: + type: integer + description: айдишник воронки + StepID: + type: integer + description: айдишник этапа + UTMs: + type: array + items: + type: integer + description: список UTM для этого опроса + FieldsRule: + type: object + description: правила заполнения полей сущностей в амо + properties: + lead: + type: array + items: + $ref: '#/components/schemas/FieldRule' + contact: + type: array + items: + $ref: '#/components/schemas/FieldRule' + company: + type: array + items: + $ref: '#/components/schemas/FieldRule' + customer: + type: array + items: + $ref: '#/components/schemas/FieldRule' + Deleted: + type: boolean + description: флаг мягкого удаления + CreatedAt: + type: integer + description: таймштамп создания воронки в нашей системе + FieldRule: + type: object + description: правила сопоставления вопроса полю + properties: + QuestionID: + type: integer + description: сопоставление айдишника вопроса полю, которое будет заполняться ответом. соответственно QuestionID это айдишник вопроса. это я так мэпу пытался записать Pipeline: type: object description: объект воронки амо @@ -340,6 +407,9 @@ components: AmoFieldID: type: integer description: айдишник кастомного поля в амо + QuizID: + type: integer + description: айдишник квиза AccountID: type: string description: связь с аккаунтом в интеграции амо