pr-cy-swagger

swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "API для работы с a.pr-cy.ru",
    "description": "Доступ к API предоставляется посредством указания параметра _key_ в запросе. Его значение можно получить, перейдя на тариф с поддержкой API ([почитать о тарифах](/prices)).\nЗдесь Вы можете ознакомиться с полным списком поддерживаемых методов, а также попробовать их в действии.\nМаксимальное количество запросов к API — 200 в час. Запросы на получение статуса анализа не ограничены. Количество обновлений анализа определяется Вашим действующим тарифом.\n",
    "version": "1.1.0"
  },
  "host": "apis.pr-cy.ru",
  "basePath": "/api/v1.1.0",
  "produces": [
    "application/json"
  ],
  "securityDefinitions": {
    "apiKey": {
      "type": "apiKey",
      "name": "key",
      "in": "query"
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "paths": {
    "/analysis/base/{domain}": {
      "get": {
        "tags": [
          "Анализ сайта"
        ],
        "summary": "Получение базового анализа",
        "operationId": "getBaseAnalysis",
        "parameters": [
          {
            "name": "domain",
            "in": "path",
            "description": "Домен сайта",
            "required": true,
            "type": "string"
          },
          {
            "name": "tests",
            "in": "query",
            "description": "Список тестов (через запятую), которые необходимо вернуть. Оставьте пустым для отображения всех тестов.",
            "type": "string"
          },
          {
            "name": "excludeHistory",
            "in": "query",
            "description": "Исключить историю - отметьте для получения тестов без истории",
            "type": "string",
            "enum": [
              0,
              1
            ],
            "default": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Массив тестов базового анализа",
            "schema": {
              "$ref": "#/definitions/Tests"
            }
          },
          "400": {
            "description": "В запросе обнаружена синтаксическая ошибка. Проверьте наличие и правильность всех параметров запроса.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Доступ ограничен.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Базовый анализ сайта не существует",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/analysis/advanced/{domain}": {
      "get": {
        "tags": [
          "Анализ сайта"
        ],
        "summary": "Получение расширенного анализа",
        "operationId": "getAdvacedAnalysis",
        "parameters": [
          {
            "name": "domain",
            "in": "path",
            "description": "Домен сайта",
            "required": true,
            "type": "string"
          },
          {
            "name": "tests",
            "in": "query",
            "description": "Список тестов (через запятую), которые необходимо вернуть. Оставьте пустым для отображения всех тестов.",
            "type": "string"
          },
          {
            "name": "excludeHistory",
            "in": "query",
            "description": "Исключить историю - отметьте для получения тестов без истории",
            "type": "string",
            "enum": [
              0,
              1
            ],
            "default": 0
          }
        ],
        "responses": {
          "200": {
            "description": "Массив тестов расширенного анализа",
            "schema": {
              "$ref": "#/definitions/Tests"
            }
          },
          "400": {
            "description": "В запросе обнаружена синтаксическая ошибка. Проверьте наличие и правильность всех параметров запроса.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Доступ ограничен.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Расширенный анализ сайта не существует",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/analysis/status/base/{domain}": {
      "get": {
        "tags": [
          "Анализ сайта"
        ],
        "summary": "Получение статуса базового анализа",
        "operationId": "getBaseAnalysisStatus",
        "parameters": [
          {
            "name": "domain",
            "in": "path",
            "description": "Домен сайта",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Массив тестов базового анализа",
            "schema": {
              "$ref": "#/definitions/Analysis"
            }
          },
          "400": {
            "description": "В запросе обнаружена синтаксическая ошибка. Проверьте наличие и правильность всех параметров запроса.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Доступ ограничен.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Базовый анализ сайта не существует",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/analysis/status/advanced/{domain}": {
      "get": {
        "tags": [
          "Анализ сайта"
        ],
        "summary": "Получение статуса расширенного анализа",
        "operationId": "getAdvacedAnalysisStatus",
        "parameters": [
          {
            "name": "domain",
            "in": "path",
            "description": "Домен сайта",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Массив тестов расширенного анализа",
            "schema": {
              "$ref": "#/definitions/Analysis"
            }
          },
          "400": {
            "description": "В запросе обнаружена синтаксическая ошибка. Проверьте наличие и правильность всех параметров запроса.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Доступ ограничен.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Расширенный анализ сайта не существует",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/analysis/update/base/{domain}": {
      "post": {
        "tags": [
          "Анализ сайта"
        ],
        "summary": "Обновление базового анализа",
        "operationId": "updateBaseAnalysis",
        "parameters": [
          {
            "name": "domain",
            "in": "path",
            "description": "Домен сайта",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/UpdateResult"
            }
          },
          "400": {
            "description": "В запросе обнаружена синтаксическая ошибка. Проверьте наличие и правильность всех параметров запроса.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Доступ ограничен.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Базовый анализ сайта не существует",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    },
    "/analysis/update/advanced/{domain}": {
      "post": {
        "tags": [
          "Анализ сайта"
        ],
        "summary": "Обновление расширенного анализа",
        "operationId": "updateAdvacedAnalysis",
        "parameters": [
          {
            "name": "domain",
            "in": "path",
            "description": "Домен сайта",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "schema": {
              "$ref": "#/definitions/UpdateResult"
            }
          },
          "400": {
            "description": "В запросе обнаружена синтаксическая ошибка. Проверьте наличие и правильность всех параметров запроса.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "403": {
            "description": "Доступ ограничен.",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          },
          "404": {
            "description": "Расширенный анализ сайта не существует",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "Tests": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/Test"
      }
    },
    "Test": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Название теста"
        },
        "updated": {
          "type": "string",
          "description": "Время последнего обновления"
        }
      }
    },
    "Analysis": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "Домен"
        },
        "created": {
          "type": "string",
          "description": "Время создания анализа"
        },
        "started": {
          "type": "string",
          "description": "Время начала обновления"
        },
        "updated": {
          "type": "string",
          "description": "Время окончания обновления"
        },
        "isUpdating": {
          "type": "boolean",
          "description": "Обновляется ли анализ"
        },
        "isExpired": {
          "type": "boolean",
          "description": "Устарел ли анализ"
        }
      }
    },
    "UpdateResult": {
      "type": "object",
      "properties": {
        "started": {
          "type": "string",
          "description": "Время начала обновления"
        }
      }
    },
    "Error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string",
          "description": "Описание ошибки"
        }
      }
    }
  }
}