{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"30e68b1e-22bc-4250-85a8-2d7548382874","name":"Matrix Services","description":"*This collection contains requests for interacting with relevant Matrix services by SmartClean.*\n\n#### **Notes:**\n\n1.  Each folder in this collection refers to a specific service within Matrix.\n2.  Each subfolder inside each service folder groups the requests based on the entity it operates on.\n    \n\n#### **URL format for each request:**\n\nEvery request in this collection has the following URL format:\n\n[*https://base-url/service-id/service-version/actions?op=operation-name*](https://baseUrl/service-id/service-version/actions?op=operation-name)\n\nWhere the base-url currently points to: *https://console.smartclean.io/prod/v2*\n\nEach section of the URL is described below:\n\n1.  **base-url:**\n    1.  Constant for all the requests\n    2.  Represents a URL in our domain reserved for making HTTPS requests.\n    3.  The current value is already set to the latest correct value, found in the \"Variables\" section of this Collection (and must not be changed unless we notify you)\n2.  **service-id:**\n    1.  Constant for all requests inside a specific service folder.\n    2.  Represents the name of our service to which the request is redirected.\n    3.  The current value is set to the correct value for each service, found in the \"Variables\" section of this Collection (and must not be changed unless we notify you)\n3.  **service-version:**\n    1.  Constant for all requests inside a specific service folder.\n    2.  Represents the version of the service specified in *service-id*\n    3.  The current value is set to the desired value for each service, found in the \"Variables\" section of this Collection (and must not be changed unless we notify you)\n4.  **operation-name:**\n    1.  Specific to each request within each service.\n    2.  Represents a specific request to the service\n    3.  The current value is set to the desired value for each request (explicitly included in the URL)\n\nNote: In case any of the constant URL sections, such as base-url, service-id and service-version (which are constant values set by us) need to be changed, we will inform you.\n\n#### **Authentication:**\n\n1.  Authentication is necessary for all requests, without which the request will fail.\n2.  If any requests contains Unauthorised or TOKEN_INVALID in the response it means the credentials are not specified, or expired.\n3.  You need to paste the credentials given to you in the \"Variables\" section of this collection (to be done only once after the Collection is imported in Postman.\n4.  By default, this collection enforces the \"Basic\" authentication scheme.\n    1.  Learn more about authentication schemes here: [https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)\n    2.  Please **obtain your credentials** (Username and Password) **from our representative**.\n    3.  Then **follow up from the below section:** \"How to add username and password\")\n5.  If desired, you may **switch to a more secure authentication** (based on SHA-256 HMAC signing)\n    1.  You will be provided an **Access Key** and **Secret Key** (Instead of Username and Password)\n    2.  See the section: \"Switch to HMAC Signing for more secure Authorization\" below.\n\n#### **How to add username and password:**\n\n1.  Go to the tab \"Variables\" for this collection\n    1.  Tip: In Postman, click on this Collection in your sidebar, then click on the \"Variables\".\n2.  Paste the Username and Password provided to you as the CURRENT VALUE of the variables: **\"***sc-username***\"** and **\"***sc-password***\"** respectively.\n    1.  **Important:** **Paste these values under the column**: \"*CURRENT VALUE\"* for the corresponding \"VARIABLE\" name (there is **no need to change the values under the column:** \"*INITIAL VALUE\"*, as these are just dummy placeholders)\n3.  Press CTRL + S or click the save icon on top right to save this key, then you may proceed to make the requests.\n4.  This will allow you to make requests to all the services in this collection.\n    1.  So, there is no need to get and paste a new Username and Password for each request in any of the included services.\n\n#### **Switch to HMAC Signing for more secure Authorization**\n\nIn case you want to switch from the simple (Basic) authentication to the more strict HMAC based authentication, please do the following.\n\n1.  Request our representative to **receive your HMAC credentials** (i.e. Access Key and Secret Key).\n2.  Go to the **Variables section** in the collection and **Update the** CURRENT VALUE **of the** variable**:** *auth-type* to ***hmac*** (from the default \"basic\")\n3.  **Paste the Access Key and Secret Key given to** you as the **CURRENT VALUE of the variables**: \"*sc-hmac-access-key*\" and \"*sc-hmac-secret-key*\" respectively.\n    \n\n#### **Operation names:**\n\nEach request in each of the services is identified by its operation name which is provided in the query parameters of the request URL as \"op\".\n\n#### **Service Versions:**\n\nEach service in this collection also has a version, which are currently the latest stable versions for each service.\n\nThe version to use, comes from the CURRENT VALUE of the Variable named as: \"*service-version\" and* ***must not be changed.***\n\nFor examples:\n\n1.  For the service: *Grids*, the version to use comes from the CURRENT VALUE of the Variable: *grids-version.*\n2.  For *Device Management*: the version to use comes from the CURRENT VALUE of the Variable: *devicemanagement-version*\n    \n\n**In case these versions are changed in future**, we will notify you to update the version in the collection variables to the desired value.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2593073","team":307386,"collectionId":"30e68b1e-22bc-4250-85a8-2d7548382874","publishedId":"UVsPQ4vL","public":true,"publicUrl":"https://documenter-api.postman.tech/view/2593073/UVsPQ4vL","privateUrl":"https://go.postman.co/documentation/2593073-30e68b1e-22bc-4250-85a8-2d7548382874","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-single-column","customisation":null,"version":"8.10.1","publishDate":"2022-03-19T08:37:39.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/214863c5da4ff05a5ba5d55b94e99d29aaf94e603cb18556ca9c7224a256dc2f","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"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVsPQ4vL"}