{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"77b80cc3-8c43-4f3c-a545-1e47a9ce8556","name":"Octoclick API","description":"# Authorization\n\nВ нашей сети реализована авторизация с помощью bearer-token.  \nПри каждой авторизации, токен приходит в **body** ответа.\n\nЗапрос: `octoclick.com/auth/email`  \nОтвет:\n\n``` json\n...\n\"data\": { \n  \"token\": \"eyJ0e...\",\n}\n...\n\n```\n\nПользователь должен отправлять токен в хэдере \"Authorization\" при каждом API-запросе.\n\nПример: `Authorization: Bearer {token_here}`\n\n``` json\n...\n\"Content-Type\": \"application/json\",\n\"Authorization\": \"Bearer eyJ0e...\"\n...\n\n```\n\nСрок действия токена можно найти в **payload,** поле \"**exp**\" - [`https://jwt.io/`](https://jwt.io/)\n\n``` json\n{\n  ...\n  \"iat\": 1234567890,\n  \"exp\": 1234567890,\n  \"nbf\": 1234567890,\n  ...\n}\n\n```\n\n# Request\n\nНаше приложение принимает запросы следующих типов - `GET, POST, PATCH, DELETE`.\n\n`GET` - используется для получения одного объекта или списка объектов, в зависимости от конкретного запроса.  \n`POST` - метод для создания объекта. В основном, оперирует данными указанными в теле запроса.  \n`PATCH` - служит для обновления объектов. Принимает идентификатор объекта к изменению и поля, которые нужно обновить.  \n`DELETE` - удаляет объект, чей идентификатор передан в запросе.\n\n## Path params\n\nPath parameters - переменные части url. Обычно используются для указания на определенный объект в системе. Например в ссылке - `https://api.octoclick.com/api/v3/site/1`, `1` отвечает за идентификатор объекта сайт. URl-адрес может иметь несколько параметров пути, в большинстве случаев этот параметр следует после имени объекта.\n\n# Response\n\nЗапрос содержит две составляющие: meta и data.\n\n``` json\n \"meta\": {\n        \"pagination\": {\n            \"per_page\": 10,\n            \"current_page\": 1,\n            \"last_page\": 1,\n            \"total\": 10\n        },\n        \"status\": true,\n        \"code\": 200\n    },\n\"data\": [ ... ]\n\n```\n\nВ случае, если запрашивается список объектов, блок meta будет содержать дополнительную информацию в поле `pagination` . Подробнее о каждом поле этого блока в разделе Pagination.\n\nЗначение поля `status` содержит информацию об статусе запроса, удачный - true, неудачный - false.  \nЗначение поля `code` детализирует статус запроса.\n\n`2XX` - запрос выполнен удачно.\n\n`4XX` - код ошибки, который говорит о неправильном запросе со стороны пользователя.\n\n`5XX` - ошибка сервера.\n\nБлок `data` содержит результат выполнения запроса в формате JSON.\n\n# Erorrs\n\n## Validation errors\n\nГоворят о том, что переданные данные имеют недопустимые значение или формат.\n\nОшибки валидации приведены в следующем примере:\n\n``` json\n\"meta\": {\n        \"status\": false,\n        \"code\": 400\n    },\n\"data\": [],\n\"errors\": [\n        {\n            \"field\": \"name\",\n            \"title\": \"The field is required.\",\n            \"type\": \"validation\"\n        },\n        {\n            \"field\": \"url\",\n            \"title\": \"The field format is invalid.\",\n            \"type\": \"validation\"\n        }\n\n```\n\n`field` содержит название поля.  \n`title` подробная информация о причине возниконовения ошибки.  \n`type` тип ошибки, в данном случае, данные не прошли валидацию.\n\n## API errors\n\n``` json\n\"meta\": {\n        \"status\": false,\n        \"code\": 401\n    },\n    \"data\": [],\n    \"errors\": [\n        {\n            \"title\": \"User not found\",\n            \"type\": \"exception\"\n        }\n    ]\n\n```\n\n# Filters\n\nЗапросы отвечающие за предоставление списков данных, имеют ряд опций.\n\nУстановив значение фильтра, вы ограничите результат выполнение запроса и сократите список полученных объектов лишь теми, что подходят под установленный критерий.\n\nСписок допустимых значений для каждого фильтра можно получить по пути из словарей, указанном в поле `description`.\n\nКаждый фильтр имеет структуру `filter[key:=]=value` где `key` - искомое поле, знак после `:` оператор и `value` - значение.\n\nСписок допустимых операторов:\n\n`=` равно\n\n`!=` не равно\n\n`>=` больше или равно\n\n`<=` меньше или равно\n\n`<` меньше\n\n`>` больше\n\n`in` все значения из списка `value`\n\n`nin` исключить из выборки все значения переданные в `value`\n\n`like` вхождение переданного параметра в искомом поле\n\nВ случае, если используется оператор `in` или `nin` , `value` должно быть передано через запятую .\n\n**Примеры**:\n\nURL получения списка креативов - `.../campaign/creative`\n\nURL с выставленным фильтром по полю `status` - `.../campaign/creative?filter[status:in]=3,5` .\n\nВсе последующие фильтры добавляются с префиксом `&` .\n\nСледующий запрос вернет список креативов на паузе, имеющих в поле `text`, значение `creative_text` - `.../campaign/creative?filter[status:=]=4&filter[text:like]=creative_text`\n\n# Pagination.\n\nДля удобства восприятия, ответы с большим количеством элементов разграничены по страницам. Пагинация также имеет опции выставляемые пользователем.\n\n`page[number]` - значение переданное в этот параметр отвечает за номер страницы.\n\n`page[size]` - количество элементов отображаемых на каждой странице. Максимально допустимое значение - 100.\n\nПараметры пагинации передаются аналогично фильтрам:  \n`.../campaign/creative?page[size]=10&page[number]=1`\n\n# Language.\n\nНа данный момент в нашей системы поддерживаются два языка: RU и EN.\n\nПримеры получения списка словарей на английском и русском языке:  \n`.../dictionary/?lang=en`  \n`.../dictionary/?lang=ru`\n\nМы рекомендуем передавать этот параметр в каждом API запросе, так как некоторые части ответов могут быть локализованы.\n\n# Dictionaries\n\nНекоторые поля у объектов в нашей системе имеют строгий, конечный список допустимых значений.  \nПолучить все подобные списки можно по URL - `.../dictionary` .\n\nВыполнив запрос `.../dictionary`, вы получите массив из списков, например,  \nразрешенные в нашей системе страны, браузеры, группировки и т.д.\n\n```\n'browser' => [...],\n'operator' => [...],\n'language' => [...],\n'country' => [...],\n...\n\n```\n\n# Bcid\n\nКаждый объект нашей системы имеет внутренний уникальный идентификатор \"bcid\". Это инкрементальное значение, берущее на себя роль универсального идентификатора среди всех баз данных.\n\nВсе запросы поиска объектов по порядковому номеру, принимают в качетсве параметра bcid.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17656280","team":2404559,"collectionId":"77b80cc3-8c43-4f3c-a545-1e47a9ce8556","publishedId":"Uz5KkEde","public":true,"publicUrl":"https://documenter-api.postman.tech/view/17656280/Uz5KkEde","privateUrl":"https://go.postman.co/documentation/17656280-77b80cc3-8c43-4f3c-a545-1e47a9ce8556","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2023-11-02T14:21:50.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"OctoClick Production","id":"84d879ec-4b4f-4607-ad85-d02cdfde2143","owner":"3846313","values":[{"key":"base_url","value":"https://api.octoclick.com/api/v3","enabled":true,"type":"default"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FwaS5vY3RvY2xpY2suY29tL2FwaS92My9hdXRoL2VtYWlsIiwiaWF0IjoxNjc5OTUwNDk0LCJleHAiOjE3MTU5NTA0OTQsIm5iZiI6MTY3OTk1MDQ5NCwianRpIjoiTkZEeXVHREY3SzVnRE40ciIsInN1YiI6IjYzZjMzMmY4ZWM3MWY4Y2IyZDBlMjNkMiIsInBydiI6IjIzYmQ1Yzg5NDlmNjAwYWRiMzllNzAxYzQwMDg3MmRiN2E1OTc2ZjcifQ.QFPjQ_4tHwZI9UMW_i5q4cLev5PuiSK4AOorjcqoz2s","enabled":true,"type":"default"},{"key":"kraken_base_url","value":"http://ssp.octoclick.com","enabled":true,"type":"default"},{"key":"ad_point_base_url","value":"http://ad_point_nginx.octo","enabled":true,"type":"default"},{"key":"seabus_base_url","value":"http://seabus_nginx.octo","enabled":true,"type":"default"},{"key":"ogre_base_url","value":"http://ogre_nginx.octo","enabled":true,"type":"default"},{"key":"base_url_v4","value":"https://api.octoclick.com/api/v4","enabled":true},{"key":"ssp_feed\n","value":"0a02958f-8f4f-4681-a3c7-8532725d322c","enabled":true,"type":"default"}],"published":true}],"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/95579ddc8b23e42105384447eb526ecfcd15be7a9740539fd5bb64104c022d6b","favicon":""},"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"},{"label":"OctoClick Production","value":"3846313-84d879ec-4b4f-4607-ad85-d02cdfde2143"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Uz5KkEde"}