{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"59b1fe7b-0177-42f0-a870-68377373c9b0","name":"Demo PW REST API сервер","description":"# Введение\n\nAPI разработано для поддержки условного веб-приложения Parrot Wings и содержит минимальный набор методов, необходимых для авторизации и регистрации клиентов и удаленного вызова процедур. \nAPI реализует автономный http-сервер, написанный на Go https://github.com/wtask/pwsrv.\n\n\n# Аутентификация и авторизация\n\nВсе методы, реализующие бизнес-логику веб-приложения требуют авторизации пользователя (клиент, выполняющий запрос). Для аутентификации предусмотрен метод `POST /login/`, в результате чего пользователю предоставляется токен, который необходимо использовать при дальнейшей работе с API. Токен имеет ограниченное время действия. При его истечении на любой запрос с использованием некорректного токена, сервер возвращает ответ с ошибочным HTTP-статусом 401 (unauthorized).\nТокены, предоставляемые сервером являются упрощенной версей [JWT](https://jwt.io/)\n\nПредусмотрена регистрация новых пользователей. Для этого необходимо использовать метод `POST /register/`. В результате успешной регистрации, сервер сразу предоставляет токен авторизации, после чего можно работать с API.\n\nПредоставленный токен должен передаваться в заголовке запроса `Authorization`, например:\n\n```\nGET /users/3/ HTTP/1.1\nHost: localhost:8000\nAuthorization: Bearer eyJJc3N1ZXIiOiJQVyBEZW1vIHNlcnZlciIsImV4cCI6MTU0OTYzMzM4OSwic3ViIjoxfQ.49C318750DB785AD276684E7DC34C019\n```\n\n\n# Ошибки\n\nВсе ошибки API возвращаются в виде ответа сервера с одним из ошибочных http-статусов и телом ответа в json-формате вида:\n\n```json\n{\n\t\"error\": true,\n\t\"message\": \"error message\"\n}\n```\n\nДля индикации ошибок используются следующие HTTP-статусы:\n* 400 (bad request)\n* 401 (unauthorized)\n* 403 (forbidden)\n* 409 (conflict)\n* 500 (internal server error)\n* 503 (service unavailable)\n\nВсем успешным запросам соответствует HTTP-статус 200.\n\n\n# Предусмотренные ограничения\n\nПри авторизации пользователей также проверяется уровень их прав с помощью упрощенной системы ролей. Все пользователи регистрируемые через API получают роль с \"пониженными\" правами и могут пользоваться ограниченным набором методов. Для доступа ко всему API, необходимо изменить роль пользователя в БД сервера. Интерактивный API-метод для изменения роли не предусмотрен.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6496185","team":257241,"collectionId":"59b1fe7b-0177-42f0-a870-68377373c9b0","publishedId":"Rztpq7Wy","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6496185/Rztpq7Wy","privateUrl":"https://go.postman.co/documentation/6496185-59b1fe7b-0177-42f0-a870-68377373c9b0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.12.2","publishDate":"2019-02-08T10:16:39.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Default","id":"01a31f38-bbd7-4c21-8b70-307199ab2b24","owner":"6496185","values":[{"key":"HTTPHostPort","value":"http://localhost:33333","enabled":true},{"key":"APIPathPrefix","value":"counter/v1","enabled":true},{"key":"ClientBearer","value":"dGVzdC1jbGllbnQtY29uZmlkZW50aWFsOmUyZTc3NDUyLTFiM2MtNGE1ZC05MzlhLTNhNWE2YWEwM2QwOQ==","enabled":true}],"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/bf081a9508f7def6251a63fb3643fc2c8f84460636931dadffdf77e14bf345f9","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":"Default","value":"6496185-01a31f38-bbd7-4c21-8b70-307199ab2b24"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/Rztpq7Wy"}