{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fa4b513c-a13f-4deb-8576-e257142dc51a","name":"TGZ DISTRO API","description":"TECNOGAZ PUBLIC API FOR END-USER AND DISTRO INTEGRATION\n\nFor each subscriber of the **DISTRO contract** designated for the consumption of the following APIs, **TECNO-GAZ** will provide an **access token** that enables the use of the APIs. The token will remain valid for the entire duration of the signed contract.\n\nFor every API consumption contract signed with TECNO-GAZ, **a single and unique security token** will be issued. This token serves as the access key to the data exposed through the following APIs. The token may be renewed periodically or upon request by the contract subscriber.\n\nEach token will only grant access to the APIs related to the **serial numbers associated with that token**.\n\n#### **Technical specifications of the access token:**\n\n- Maximum number of API calls per minute: **100**\n    \n- **Multi-region value caching** enabled via **CDN**\n    \n- Data available for query throughout the duration of the **active contract**\n    \n- **Data persistence** is guaranteed until the contract's expiration\n    \n\n### API Authentication and Testing Instructions\n\nTo authenticate API requests, you must include the following headers:\n\n```\n--header 'Content-Type: application/json' \\\n--header 'x-tgz-distro-token: YOUR_DISTRIBUTOR_TOKEN'\n\n ```\n\n- `Content-Type: application/json` specifies the format of the request body.\n    \n- `x-tgz-distro-token` is the custom header used to pass your **distributor access token**.\n    \n\nFor **distributors, partners, or clients** involved in the testing phase, the following **test token** is already registered in the `APITOKEN` table of the **Tecnogaz IoT database**:\n\n- **Token ID**: _(Provided by Tecnogaz)_\n    \n- **UUID**: _(Provided by Tecnogaz)_\n    \n- **Linked to contract (Distro ID)**: _(Provided by Tecnogaz)_\n    \n- **Associated device SN**: _(Provided by Tecnogaz)_\n    \n\n---\n\n### API Testing Objectives\n\nThe goal is to ensure that API calls:\n\n- Are correctly authenticated via token\n    \n- Comply with security requirements\n    \n- Return the expected data\n    \n\n---\n\n### API Features\n\nThe APIs follow the **REST protocol** and allow:\n\n- Cycle management\n    \n- Report retrieval\n    \n- Alarms and alerts consultation\n    \n\nEach call must be authenticated via an access token passed in the header, which is associated with both the device and the distributor contract.\n\n---\n\n### API Testing Process\n\n1. **Verify authentication** using the provided token\n    \n2. **Execute test calls** to main endpoints and verify the responses\n    \n3. **Handle error scenarios** to simulate malfunction conditions\n    \n4. **Validate security** to ensure access is limited to authorized users\n    \n5. **Use Postman or similar tools** in a test environment to simulate API requests","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"44561737","team":7079748,"collectionId":"fa4b513c-a13f-4deb-8576-e257142dc51a","publishedId":"2sB2qdi16h","public":true,"publicUrl":"https://api.tecnogaz.com","privateUrl":"https://go.postman.co/documentation/44561737-fa4b513c-a13f-4deb-8576-e257142dc51a","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009FE3"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/84fb7853-f23d-4012-a71e-730e65dad3dc/TG9nby1URy12ZXR0b3JpYWxlLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"009FE3"}},{"name":"light","logo":"https://content.pstmn.io/84fb7853-f23d-4012-a71e-730e65dad3dc/TG9nby1URy12ZXR0b3JpYWxlLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009FE3"}}]}},"version":"8.10.1","publishDate":"2025-06-30T06:24:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/84fb7853-f23d-4012-a71e-730e65dad3dc/TG9nby1URy12ZXR0b3JpYWxlLnBuZw==","logoDark":"https://content.pstmn.io/84fb7853-f23d-4012-a71e-730e65dad3dc/TG9nby1URy12ZXR0b3JpYWxlLnBuZw=="}},"statusCode":200},"environments":[{"name":"Tecno-gaz","id":"b3bfdfd2-0328-4580-869f-50eb33745720","owner":"44561737","values":[{"key":"tecnogazEnviroment","value":"https://s.tecnogaz.com/tgzgateway/services","enabled":true,"type":"default"},{"key":"AURA_SN","value":"PXZPB5899","enabled":true,"type":"default"},{"key":"ONYX_SN","value":"OWZXY8927","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/3af9384f80c41d251fbd77a298319273b11d671510e1f526a2e1f1b05fe3571b","favicon":"https://tecnogaz.com/favicon.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":"Tecno-gaz","value":"44561737-b3bfdfd2-0328-4580-869f-50eb33745720"}],"canonicalUrl":"https://api.tecnogaz.com/view/metadata/2sB2qdi16h"}