{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e30218a7-e514-4038-969d-ba0cfd018371","name":"alloka","description":"# 1. Введение\n\n**Входная точка:** https://api.alloka.ru/v2/\n\n**Текущая актуальная версия:** v2.\n\n**Тип: JSON API.** Используется 4 вида HTTP-запросов — GET, POST, PUT и DELETE.\n\n**Механизм авторизации:**\n\n  * API-Key Basic Auth (API-ключ авторизации получается в профиле пользователя https://analytics.alloka.ru/profile).\n  * При помощи токена в HEADERS 'X-AUTH-TOKEN'\n  * При помощи передечи токена как параметра 'auth_token'\n\n**Формат данных:** JSON (application/json). Необходимо указывать заголовок Content-Type.\n\n<aside class=\"notice\">\n  Внимание! Не выкладывайте свой API-ключ авторизации в открытый доступ. Данный ключ должен надёжно храниться на вашем сервере. Вы не должны выводить его в HTML или JavaScript. В противном случае, злоумышленники смогут получить доступ к API от имени вашего пользователя.\n</aside>\n\n<aside class=\"notice\">\n  Рекомендация —  При малейших подозрения о утечке вашего API-ключа в открытый доступ или в руки посторонних лиц, вам следует сбросить API-ключ в профиле вашего личного кабинета — https://analytics.alloka.ru/profile.\n</aside>\n\n# 2. Base information - базовая информация\n**Примеры выполнения запросов к Alloka API при помощи различных технологий**\n\nЗдесь приведены примеры запросов к Alloka API при помощи утилиты cURL, а также языков PHP, Ruby и Python\nHTTP авторизация в утилите cURL происходит указанием следующего аргумента:\ncurl -u username:password\nВ примере запроса c curl — user - API-ключ, а password параметр должен быть пуст:\ncurl -u <ВАШ_API_КЛЮЧ>:\n\n> Sample request\n\n```ruby\nrequire \"uri\"\nrequire \"net/https\"\n\n# Ваш API-ключ авторизации\napi_key = \"gnLZYz0FexchC6RFPyP0PBb9n26cecQh\"\n\n# URL запроса\nuri = URI.parse(\"https://api.alloka.ru/v2/\")\n\n# Создаём объекты запроса\nhttp = Net::HTTP.new(uri.host, uri.port)\nhttp.use_ssl = true\nhttp.verify_mode = OpenSSL::SSL::VERIFY_PEER\nrequest = Net::HTTP::Get.new(uri.request_uri)\n\n# Авторизация\nrequest.basic_auth(api_key, \"\")\n\n# Заголовки запроса\nrequest.headers[\"Content-Type\"] = \"application/json\"\n\n# Выполняем запрос\nresponse = http.request(request)\n\n# Ваша обработка ответа\nputs response.body\n```\n\n```python\nimport httplib2\n\n# Ваш API-ключ авторизации\napi_key = \"gnLZYz0FexchC6RFPyP0PBb9n26cecQh\"\n\n# URL запроса\nurl = \"https://api.alloka.ru/v2/\"\n\n# Создаём объект запроса\nhttp = httplib2.Http()\n\n# Авторизация\nhttp.add_credentials(api_key, '')\n\n# Заголовки запроса\nheaders = {'Content-type': 'application/json'}\n\n# Выполняем запрос\nresponse, content = http.request(url, 'GET', headers=headers)\n\n# Обработка ответа\nprint(content)\n```\n\n```shell\ncurl -X GET \"https://api.alloka.ru/v2/\" -u gnLZYz0FexchC6RFPyP0PBb9n26cecQh:  -v\n```\n\n```php\n<?php\n// URL запроса\n$ch = curl_init(\"https://api.alloka.ru/v2/\");\n\n// Ваш API-ключ авторизации\n$api_key = \"gnLZYz0FexchC6RFPyP0PBb9n26cecQh\";\n\n// Авторизация\ncurl_setopt($ch, CURLOPT_USERPWD, $api_key . \":\");\n\n// Заголовки запроса\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array(\n  \"Content-Type: application/json\"\n));\n\n// Выполняем запрос\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n$result = curl_exec($ch);\n\n// Закрываем соедиениние\ncurl_close($ch);\n\n/* Обработка ответа */\necho $result;\n?>\n```\n\n```javascript\nlet\n  url = 'https://api.alloka.ru/v2/',\n  apiKey = 'gnLZYz0FexchC6RFPyP0PBb9n26cecQh';\n\n\nfetch(url, {\n  headers: {\n    'Content-Type': 'application/json',\n    'X-AUTH-TOKEN': apiKey\n  },\n\n  body: {}\n})\n    .then(function(response) {\n        return response.json();\n     })\n\n    .then(function(data) {\n      console.log(data);\n    })\n\n    .catch(console.log);\n```\n\n# 3. Methods - методы HTTP в Alloka API\nAlloka API использует 4 HTTP метода в различных случаях:\n\n* GET — для получения каких-либо данных. Это может быть список ресурсов, единичный ресурс и т.п.\n* POST — для создания нового ресурса, переключения состояния ресурса или вызова специфичных запросов.\n* PUT — обновление ресурса.\n* DELETE — удаление ресурса.\n\nВ подробном описание каждого запроса указан необходимый метод HTTP.\n\n# 4. Versions - версии Alloka API\nИспользуемая версия API должна содержаться в URL каждого запроса сразу после домена:\nhttps://api.alloka.ru/v2/\n\nТекущая наиболее актуальная версия - v2. В будущем, при наличии серьёзных изменений в работе, будут создаваться новые версии. Тем не менее, текущая версия также будет функционировать. Поэтому вы можете не беспокоиться за то, что ваша интеграция с Alloka внезапно перестанет работать из-за изменений в API.\n\n# 5. Pagination - пагинация — разбиение списка ресурсов по страницам\n\nНекоторые из запросов Alloka API выводят массив ресурсов. В таком случае, ответ на запрос будет разбиваться на страницы исходя из значения следующих параметров, которые также можно передать входными параметрами запроса:\n\n* per_page — количество элементов на странице.\n* page — номер страницы. Может принимать любое положительное целочисленное значение.\n\nТакже каждый ответ на запрос списка ресурсов содержит два поля, помогающие узнать суммарное количество элементов по запросу, общее количество страниц, а также количество элементов в данном ответе:\n\n```json\n{\n  \"meta\": {\n    \"pagination\": {\n      \"current_page\": 1,\n      \"next_page\": null,\n      \"prev_page\": null,\n      \"total_pages\": 1,\n      \"total_objects\": 8\n    }\n  }\n}\n```\n\n# 6. HTTP codes - коды статуса HTTP\n Успешность выполнения запроса к Alloka API определяется HTTP-кодом ответа.\n\nКод статуса HTTP                  | Описания значения в Alloka API\n--------------------------------- | ------------------------------------------------------------------------------\n200 OK            | Успешная операция\n401 Unauthorized  | Неавторизованный доступ\n403 Forbidden | Доступ к запрашиваемому ресурсу запрещён\n404 Not Found | Запрашиваемый ресурс не найден\n500 Internal Server Error, 502 Bad Gateway, 503 Service Unavailable, 504 Gateway Timeout | Внутренняя ошибка\n\nВ случае, если вы уверены, что ваш запрос корректен, но вам выдаётся ошибка, напишите нам на support@alloka.ru, указав в письме детали запроса к API (точное время, URL, параметры запроса).\n\n# 7. Errors - основные коды ошибок\n\nВ случае неудачного запроса в ответе будет содержаться поле error, которое может быть строкой или ассоциативным массивом строк.\n\nКод ошибки  | Описание\n------------|--------------------------\ninvalid_json| Неправильный JSON, ошибка парсинга JSON, переданного в теле запроса\ninvalid_request | Неправильный URL запроса\nunauthorized | Неавторизованный доступ\naccess_denied | Доступ к запрашиваемому ресурсу запрещён\nnot_found | Запрашиваемый ресурс не найден\nunknown_error | Внутренняя ошибка\n\nВ случае, если вы уверены, что ваш запрос корректен, но вам выдаётся ошибка, напишите нам на support@alloka.ru, указав в письме детали запроса к API (точное время, URL, параметры запроса).\nКроме того, каждый запрос может обладать своими кодами ошибок, о чём указано в описании запросов к Alloka API.\n\n# 8. API requests - подробное описание всех запросов к Alloka API\n\nНиже представлено подробное описание всех возможных запросов к Alloka API. Каждое описание содержит тип HTTP-запроса, URL, входные параметры(если они возможны), примеры ответов, ошибки(специфичные для данного запроса).\n\n**Внимание!** Документация в процессе написания. Возможно неполное описание некоторых запросов.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"3803426","collectionId":"e30218a7-e514-4038-969d-ba0cfd018371","publishedId":"RVu1Gqf6","public":true,"publicUrl":"https://dev.alloka.com","privateUrl":"https://go.postman.co/documentation/3803426-e30218a7-e514-4038-969d-ba0cfd018371","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-11-01T09:24:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/9222118b52c1280c6f29955be9567e75d594a7ffb0fc36889c8abd58e41874e2","favicon":"https://res.cloudinary.com/postman/image/upload/v1587372592/team/fpe50jy2wk66eialexvy.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://dev.alloka.com/view/metadata/RVu1Gqf6"}