{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"05c68f73-1af1-4821-9a9f-a63da09cebdf","name":"3dEYE API v3","description":"# Getting started\n\nEvery API method can be called either by integrator or customer. This methods are marked with corresponding tags \\[Integrator\\] or \\[Customer\\]. Methods that don't require authorization marked with \\[Anonymous\\] tag.\n\nOn attempt to make an unauthorized request, you will get a response with status 401 (Unauthorized).\n\nEvery API request is authorized by API key and access token which should be sent in request headers.  \nYou can obtain API key in Admin panel while access token is obtained using auth/token method. If either token or key is omitted or invalid you will get response with status 403 (Forbidden). See the example below for details.\n\n### Request to get access token\n\n```\n    curl --location --request POST \"https://admin-api.3deye.me/v3/auth/token\"\n    --header \"accept: application/json\"\n      --header \"Content-Type: application/json\"\n      --header \"x-api-key: API_KEY\"\n      --data \"{\n        \"username\": \"intergrator\",\n        \"password\": \"passwordExample\"\n    }\"\n\n ```\n\n#### Response example:\n\n```\n{\n    \"accessToken\": \"5RR1PBrDLp4hjYayzZLtL6p0FZKPs4hsJRTAj..\",\n    \"tokenType\": \"bearer\",\n    \"expiresIn\": 1800,\n    \"refreshToken\": \"22c3241c4f41447ca9df4a566a4445d4\",\n    \"clientId\": \"ExternalApi\",\n    \"userName\": \"integrator\",\n    \"accessTokenIssued\": \"...\",\n    \"accessTokenExpires\": \"...\",\n    \"refreshTokenIssued\": \"...\",\n    \"refreshTokenExpires\": \"...\"\n}\n\n ```\n\nThen you should use `accessToken` value from this response in requests header Authorization `Bearer {accessToken}`.\n\n### Example receiving billing plans for integrator:\n\n```\n    curl --location --request GET \"https://admin-api.3deye.me/v3/plan/list\"\n    --header \"Content-Type: application/json\"\n    --header \"x-api-key: API_KEY\"\n    --header \"Authorization: Bearer 5RR1PBrDLp4hjYayzZLtL6p0FZKPs4hsJRTAj...\"                                       \n\n ```\n\n### Responses\n\nA response status of 2xx indicates the operation was successful. Other error codes indicate either a client error (4xx) or a server error (5xx).\n\n#### Models for error responses\n\n##### 400: Request error\n\n```\n{\n  \"message\": \"Error message\",\n  \"code\": \"Error code\"\n}\n\n ```\n\n##### 404: Not Found error\n\n```\n{\n  \"errors\": {\n        {\n          \"message\": \"Error message\",\n          \"code\": \"Error code\"\n        }     \n  }\n}\n\n ```\n\n##### 401, 403: Unauthorized, Forbidden error\n\n```\n{\n    \"errors\": {\n      {\n        \"message\": \"Error message\",\n        \"code\": \"Error code\"\n      }     \n    }\n}\n\n ```\n\n##### 422: Validation error\n\n```\n{\n    \"errors\": {\n      {\n        \"message\": \"Error message\",\n        \"code\": \"Error code\"\n      }     \n    }\n}\n\n ```\n\n##### 500 Server side error\n\n```\n{\n  \"errors\": {\n        {\n          \"message\": \"Error message\",\n          \"code\": \"Error code\"\n        }     \n  }\n}\n\n ```\n\n### Code generation\n\nFor generation code based on documentation you are able to use:\n\n[Swagger codegen](https://swagger.io/tools/swagger-codegen/)\n\n[NSwag](https://github.com/RicoSuter/NSwag)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"9421903","team":573104,"collectionId":"05c68f73-1af1-4821-9a9f-a63da09cebdf","publishedId":"SWLb89FH","public":true,"publicUrl":"https://documenter-api.postman.tech/view/9421903/SWLb89FH","privateUrl":"https://go.postman.co/documentation/9421903-05c68f73-1af1-4821-9a9f-a63da09cebdf","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.11.6","publishDate":"2020-01-15T20:31:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Public","id":"ba85f925-9d36-48cd-ad78-eb1fef2af9a7","owner":"9421903","values":[{"key":"baseUrl","value":"https://admin-api.3deye.me","enabled":true},{"key":"apiKey","value":"","enabled":true},{"key":"token","value":null,"enabled":true},{"key":"customerId","value":"","enabled":true},{"key":"integratorId","value":"","enabled":true},{"key":"userId","value":"","enabled":true},{"key":"roleId","value":"","enabled":true},{"key":"userName","value":"","enabled":true},{"key":"password","value":"","enabled":true},{"key":"cameraPassword","value":"","enabled":true},{"key":"cameraAdminName","value":"","enabled":true},{"key":"cameraId","value":"","enabled":true},{"key":"clientId","value":"","enabled":true},{"key":"webHookId","value":"","enabled":true},{"key":"planId","value":"","enabled":true},{"key":"dateFrom","value":"","enabled":true},{"key":"dateTo","value":"","enabled":true},{"key":"eventType","value":"","enabled":true},{"key":"eventSubType","value":"","enabled":true},{"key":"cameraRegCode","value":"","enabled":true},{"key":"cameraName","value":"","enabled":true},{"key":"cameraRoleId","value":"","enabled":true},{"key":"cameraHttpUrl","value":"","enabled":true},{"key":"cameraRtspPort","value":"","enabled":true},{"key":"cameraArchiveDurationHours","value":"","enabled":true},{"key":"cameraRtspUrl","value":"","enabled":true},{"key":"cameraBrandName","value":"","enabled":true},{"key":"newCustomerId","value":"","enabled":true},{"key":"cameraVersion","value":"","enabled":true},{"key":"cameraDescription","value":"","enabled":true},{"key":"cameraModel","value":"","enabled":true},{"key":"userGuid","value":"","enabled":true},{"key":"sharingName","value":"","enabled":true},{"key":"camerasIds","value":"","enabled":true},{"key":"shareWith","value":"","enabled":true},{"key":"expireInHours","value":"","enabled":true},{"key":"expiredAt","value":"","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/4d9f46fb667755712f3b4af3f1b5c65c799b85daf6356a59b10de8bcbb16139b","favicon":"https://res.cloudinary.com/postman/image/upload/v1578599009/team/rrzmwnow1aadcsgbewq1.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"},{"label":"Public","value":"9421903-ba85f925-9d36-48cd-ad78-eb1fef2af9a7"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/SWLb89FH"}