proxys-io.md

{ "swagger": "2.0", "info": { "title": "Proxys.io API documentation v2", "description": "Version: 2.0.0", "version": "2.0.0" }, "host": "proxys.io", "basePath": "/ru/api/v2", "schemes": [ "http" ], "paths": { "/balance": { "get": { "tags": [ "Проверка баланса пользователя" ], "summary": "User balance", "description": "Query for check user balance", "produces": [ "application/json" ], "parameters": [ { "name": "key", "in": "query", "description": "access key", "required": true, "type": "string" } ], "responses": { "200": { "description": "Balance response", "schema": { "$ref": "#/definitions/BalanceResponse" } }, "400": { "description": "unexpected error", "schema": { "$ref": "#/definitions/BalanceError" } } } } }, "/buy": { "post": { "tags": [ "Покупка новых прокси" ], "summary": "Purchase proxy", "description": "Query for purchase proxy", "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Buy" }, "type": "object" } ], "responses": { "200": { "description": "Buy response", "schema": { "$ref": "#/definitions/BuyResponse" } }, "400": { "description": "validation error", "schema": { "$ref": "#/definitions/ValidationError" } }, "default": { "description": "unexpected error", "schema": { "$ref": "#/definitions/BuyError" } } } } }, "/courses": { "get": { "tags": [], "summary": "courses", "description": "Get service courses.", "produces": [ "application/json" ], "responses": { "200": { "description": "success", "schema": { "$ref": "#/definitions/CoursesResponse" } } } } }, "/extending": { "post": { "tags": [ "Продление существующего заказа" ], "summary": "The extension of the order for 30 days", "description": "Query for extension of the order for 30 days", "produces": [ "application/json" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Extending" }, "type": "object" } ], "responses": { "200": { "description": "Buy response", "schema": { "$ref": "#/definitions/ExtendingResponse" } }, "400": { "description": "unexpected error", "schema": { "$ref": "#/definitions/ExtendingError" } } } } }, "/ip": { "get": { "tags": [ "Запрос ip адресов пользователя" ], "summary": "User ip", "description": "Query for get user ip", "produces": [ "application/json" ], "parameters": [ { "name": "key", "in": "query", "description": "access key", "required": true, "type": "string" } ], "responses": { "200": { "description": "Get Ip response order by order-key success", "schema": { "$ref": "#/definitions/IpResponseOrder" } }, "201": { "description": "Get Ip response orders list by user-key success", "schema": { "$ref": "#/definitions/IpResponseOrderList" } }, "400": { "description": "unexpected error", "schema": { "$ref": "#/definitions/IpError" } } } } }, "/overs/check-available-proxies-count": { "get": { "tags": [ "Проверка доступности к покупке необходимого количества прокси" ], "summary": "check available proxies count", "description": "Query for check available proxies count", "produces": [ "application/json" ], "parameters": [ { "name": "key", "in": "query", "description": "access key", "required": true, "type": "string" }, { "name": "service", "in": "query", "description": "Type of proxy", "required": true, "type": "integer" }, { "name": "count", "in": "query", "description": "Count of proxy", "required": true, "type": "integer" }, { "name": "country", "in": "query", "description": "Country of proxy", "required": true, "type": "string" }, { "name": "server", "in": "query", "description": "Server of proxy", "required": false, "type": "string", "default": "S1" } ], "responses": { "200": { "description": "Overs response", "schema": { "$ref": "#/definitions/OversResponse" } }, "400": { "description": "Validation error", "schema": { "$ref": "#/definitions/ValidationError" } } } } }, "/price": { "get": { "tags": [ "Запрос цены нового заказа" ], "summary": "order price", "description": "Query for check order price", "produces": [ "application/json" ], "parameters": [ { "name": "service", "in": "query", "description": "ip type", "required": true, "type": "integer" }, { "name": "count", "in": "query", "description": "ip count", "required": true, "type": "integer" }, { "name": "country", "in": "query", "description": "ip country", "required": false, "type": "string", "default": "RU" }, { "name": "period", "in": "query", "description": "rental period", "required": false, "type": "integer", "default": "30" } ], "responses": { "200": { "description": "Price response", "schema": { "$ref": "#/definitions/PriceResponse" } }, "400": { "description": "validation error", "schema": { "$ref": "#/definitions/ValidationError" } } } } }, "/services": { "get": { "tags": [ "Запрос доступных для аренды типов ip адресов" ], "summary": "services", "description": "Request for available types of ip addresses, tariffs, countries", "produces": [ "application/json" ], "parameters": [ { "name": "tariff", "in": "query", "description": "show tariff", "required": false, "type": "integer", "default": 1 }, { "name": "description", "in": "query", "description": "show description", "required": false, "type": "integer", "default": 0 } ], "responses": { "200": { "description": " success", "schema": { "$ref": "#/definitions/ServicesResponse" } } } } } }, "definitions": { "BalanceResponse": { "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "user_balance", "currency" ], "properties": { "user_balance": { "type": "integer", "format": "int32", "example": 1600 }, "currency": { "type": "string", "example": "RUB" } }, "type": "object" } }, "type": "object" }, "BalanceError": { "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "example": false }, "error": { "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32", "example": [1000, 1001] }, "message": { "type": "string", "example": [ "Указан неправильный ключ", "Указанный ключ просрочен" ] } }, "type": "object" } } }, "Buy": { "required": [ "key", "service", "count", "country", "period" ], "properties": { "key": { "type": "string", "example": "11ffc6c8fde881ae555679b299acd058ca481134" }, "service": { "type": "integer", "format": "int32", "example": 1 }, "count": { "type": "integer", "format": "int32", "example": 15 }, "country": { "type": "string", "example": "RU" }, "proxy_pool_id": { "type": "string", "example": "S1" }, "period": { "type": "integer", "format": "int32", "example": 30 }, "use_new_user": { "type": "boolean", "example": false } } }, "BuyResponse": { "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "user_email", "order_id", "count", "price", "currency", "status", "created_at", "expires_at", "key" ], "properties": { "user_email": { "type": "string", "example": "example@mail.com" }, "order_id": { "type": "integer", "format": "int32", "example": 10854 }, "count": { "type": "integer", "format": "int32", "example": 15 }, "price": { "type": "integer", "format": "int32", "example": 1600 }, "currency": { "type": "string", "example": "RUB" }, "status": { "type": "string", "example": "IN_WORK" }, "created_at": { "type": "timestamp", "format": "timestamp", "example": 1490524222 }, "expires_at": { "type": "timestamp", "format": "timestamp", "example": 1493116222 }, "key": { "type": "string", "example": "11ffc6c8fde881ae555679b299acd058ca481134" } }, "type": "object" } }, "type": "object" }, "BuyError": { "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "example": false }, "error": { "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32", "example": [1000, 1001, 1004, 1005] }, "message": { "type": "string", "example": [ "Указан неправильный ключ", "Указанный ключ просрочен", "На вашем счете не достаточно средств", "Нет прокси в таком количестве" ] } }, "type": "object" } } }, "CoursesResponse": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "$ref": "#/definitions/CourseItems" } } } }, "CourseItems": { "required": [ "buy", "sell" ], "properties": { "buy": { "type": "float", "example": "92.26" }, "sell": { "type": "float", "example": "94.49" } } }, "Extending": { "required": [ "key", "order" ], "properties": { "key": { "type": "string", "example": "11ffc6c8fde881ae555679b299acd058ca481134" }, "order_id": { "description": "Order number", "type": "integer", "format": "int32", "example": 10857 } } }, "ExtendingResponse": { "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "user_email", "order_id", "count", "price", "currency", "status", "created_at", "expires_at", "key" ], "properties": { "user_email": { "type": "string", "format": "email", "example": "example@mail.com" }, "order_id": { "type": "integer", "format": "int32", "example": 10854 }, "price": { "type": "integer", "format": "int32", "example": 1600 }, "currency": { "type": "string", "example": "RUB" }, "status": { "type": "string", "example": "IN_WORK" }, "created_at": { "type": "timestamp", "format": "timestamp", "example": 1490524222 }, "expires_at": { "type": "timestamp", "format": "timestamp", "example": 1493116222 }, "key": { "type": "string", "example": "11ffc6c8fde881ae555679b299acd058ca481134" } }, "type": "object" } }, "type": "object" }, "ExtendingError": { "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "example": false }, "error": { "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32", "example": [1000, 1001, 1002, 1003, 1004] }, "message": { "type": "string", "example": [ "Указан неправильный ключ", "Указанный ключ просрочен", "Заказ 10258 не найден и не может быть продлен", "Статус заказа не позволяет продление", "На вашем счете не достаточно средств" ] } }, "type": "object" } } }, "IpError": { "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "example": false }, "error": { "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32", "example": [1000, 1001] }, "message": { "type": "string", "example": [ "Указан неправильный ключ", "Указанный ключ просрочен" ] } }, "type": "object" } } }, "IpResponseOrder": { "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "example": true }, "data": { "$ref": "#definitions/IpResponse" } }, "type": "object" }, "IpResponseOrderList": { "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "$ref": "#/definitions/IpResponse" } } }, "type": "object" }, "IpResponse": { "properties": { "order_id": { "type": "number", "example": 10854 }, "ip_version": { "type": "string", "example": "4" }, "username": { "type": "string", "example": "bob" }, "password": { "type": "string", "example": "password" }, "ip_access": { "description": "Empty if not set", "type": "string", "example": "195.122.253.104" }, "expires_at": { "type": "timestamp", "format": "timestamp", "example": 1493116222 }, "list_ip": { "type": "array", "items": { "$ref": "#/definitions/IpItem" } } }, "type": "object" }, "IpItem": { "required": [ "ip", "port_socks", "port_http", "port_https" ], "properties": { "ip": { "type": "string", "example": "195.122.253.104" }, "port_socks": { "type": "string", "example": "18859" }, "port_http": { "type": "string", "example": "8859" }, "port_https": { "type": "string", "example": "8859" } } }, "OversResponse": { "required": [ "success" ], "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" }, "PriceResponse": { "required": [ "success", "data" ], "properties": { "success": { "type": "boolean", "example": true }, "data": { "required": [ "price", "currency" ], "properties": { "price": { "type": "double", "example": 150 }, "currency": { "type": "string", "example": "RUB" } }, "type": "object" } }, "type": "object" }, "ServicesResponse": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "$ref": "#/definitions/DataItems" } } } }, "DataItems": { "required": [ "service_id", "service_name", "periods", "available_countries", "tariffs" ], "properties": { "service_id": { "type": "integer", "example": 1 }, "service_name": { "type": "string", "example": "IPv4 индивидуальные прокси" }, "periods": { "type": "object", "example": [30, 60, 90] }, "service_description": { "type": "string", "example": "IPv4 (англ. Internet Protocol version 4) — четвёртая версия интернет протокола (IP). Первая широко используемая версия. Работает стабильно со всеми сайтами в сети." }, "available_countries": { "type": "array", "items": { "$ref": "#/definitions/CountriesItems" } }, "tariffs": { "type": "array", "items": { "$ref": "#/definitions/TariffsItems" } } } }, "CountriesItems": { "required": [ "country_code", "country_name" ], "properties": { "country_code": { "type": "string", "example": "RU" }, "country_name": { "type": "string", "example": "Россия" } } }, "TariffsItems": { "required": [ "count_min", "count_max", "name", "price", "currency" ], "properties": { "count_min": { "type": "integer", "example": 1 }, "count_max": { "type": "integer", "example": 4 }, "name": { "type": "string", "example": "Basic" }, "price": { "type": "integer", "example": 150 }, "currency": { "type": "string", "example": "RUB" } } }, "Error": { "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "example": false }, "error": { "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32", "example": [1000, 1001, 1002, 1003, 1004] }, "message": { "type": "string", "example": [ "Указан неправильный ключ", "Указанный ключ просрочен", "Заказ 10258 не найден и не может быть продлен", "Статус заказа не позволяет продление", "На вашем счете не достаточно средств" ] } }, "type": "object" } } }, "ValidationError": { "required": [ "success", "error" ], "properties": { "success": { "type": "boolean", "example": false }, "error": { "required": [ "code", "message" ], "properties": { "code": { "type": "integer", "format": "int32", "example": 2000 }, "message": { "type": "object", "example": { "count": [ "Значение «Количество ip адресов» должно быть не меньше 1." ] } } }, "type": "object" } } }, "ApiResponse": { "properties": { "code": { "description": "code of result", "type": "integer", "format": "int32" }, "type": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "integer", "format": "int64", "enum": [1, 2] } }, "xml": { "name": "##default" } } } }