{"id":314,"date":"2025-04-01T12:46:46","date_gmt":"2025-04-01T12:46:46","guid":{"rendered":"http:\/\/www2.gimasi.com\/?docs=giot-portal\/api"},"modified":"2025-04-01T12:46:46","modified_gmt":"2025-04-01T12:46:46","slug":"api","status":"publish","type":"docs","link":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api","title":{"rendered":"API"},"content":{"rendered":"<p>[vc_row][vc_column][vc_column_text css=\\&#8221;\\&#8221;]<\/p>\n<style>\n  h3 {<br \/>\n    color: #0A3D62; \/* Blu scuro *\/<br \/>\n    font-weight: bold;<br \/>\n  }<\/p>\n<p>  strong, b {<br \/>\n    color: #0A3D62; \/* Blu scuro *\/<br \/>\n  }<br \/>\n<\/style>\n<h3>API Key Setup<\/h3>\n<p>To access the API, you first need to create an authentication key within<br \/>\nthe system.<br \/>\nLog in to your administrator tenant account and navigate to the Tenant<br \/>\npage from the Administration menu. Select the API tab and click on the<br \/>\nCreate API key button. Enter a name, description, expiry date, and select a<br \/>\ntenant whose data the API key will access. Choose the necessary permissions<br \/>\nfor the API key, then click Next. Important: Ensure to store the API Key<br \/>\nsecurely, it will not be displayed again! Administrators can cancel the<br \/>\nAPI key creation by clicking Cancel.<\/p>\n<h3>API Key Settings<\/h3>\n<p>After creating the API key, you can modify its name, description,<br \/>\npermissions and expiry date in API Key Settings tab accessed through the<br \/>\nEdit button. Ensure that the correct permissions are set; otherwise, the token<br \/>\nwill fail authentication if incorrect or no permissions are assigned.<br \/>\nAPI Key permissions define which types of API calls the token can<br \/>\nperform:<\/p>\n<ul>\n<li> <strong> Read Permission:<\/strong> Allows the API token to retrieve data from the<br \/>\nsystem. This is associated with all GET requests. <\/li>\n<li> <strong> Write Permission:<\/strong> Allows the API token to modify existing data<br \/>\nwithin the system. This is associated with PUT requests.<\/li>\n<li> <strong> Create Permission:<\/strong> Allows the token to create new resources<br \/>\nwithin the system. This is associated with POST requests.<\/li>\n<li> <strong> Delete Permission:<\/strong> Allows the token to remove resources from<br \/>\nthe system. This is associated with DELETE requests.<\/li>\n<\/ul>\n<p>API Key expiry data determines the date after which the API Key will no<br \/>\nlonger be valid. This ensures that keys are not active indefinitely, adding an<br \/>\nadditional layer of security. If no expiry date is set, the key remains valid<br \/>\nuntil manually revoked.<\/p>\n<h3>API Key Group<\/h3>\n<p>In the API Key Group tab, you can assign a specific tenant or device<br \/>\ngroup to the API key. This defines which tenant or device group data the API<br \/>\nkey is allowed to access.<\/p>\n<ul>\n<li>If an API key is associated with a tenant, it can only access groups<br \/>\nand devices within that tenant through API requests.<\/li>\n<li>If an API key is associated with a device group, it can only access<br \/>\ndevices within that group through API request.<\/li>\n<li>If no tenant or group is assigned to the API key the token will have<br \/>\naccess to all groups and devices within all available tenants.<\/li>\n<\/ul>\n<p>This setup allows fine-grained control over what devices the API key can<br \/>\ninteract with, ensuring that keys are restricted to specific tenants or\/and<br \/>\ndevice groups when necessary.[\/vc_column_text][\/vc_column][\/vc_row]<\/p>\n","protected":false},"featured_media":0,"parent":289,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"_uag_custom_page_level_css":"","site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"doc_tag":[],"class_list":["post-314","docs","type-docs","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.2 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>API -<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API -\" \/>\n<meta property=\"og:description\" content=\"[vc_row][vc_column][vc_column_text css=&#8221;&#8221;] API Key Setup To access the API, you first need to create an authentication key within the system. Log in to your administrator tenant account and navigate to the Tenant page from the Administration menu. Select the API tab and click on the Create API key button. Enter a name, description, expiry date, and select a tenant whose data the API key will access. Choose the necessary permissions for the API key, then click Next. Important: Ensure to store the API Key securely, it will not be displayed again! Administrators can cancel the API key creation by clicking Cancel. API Key Settings After creating the API key, you can modify its name, description, permissions and expiry date in API Key Settings tab accessed through the Edit button. Ensure that the correct permissions are set; otherwise, the token will fail authentication if incorrect or no permissions are assigned. API Key permissions define which types of API calls the token can perform: Read Permission: Allows the API token to retrieve data from the system. This is associated with all GET requests. Write Permission: Allows the API token to modify existing data within the system. This is associated with PUT requests. Create Permission: Allows the token to create new resources within the system. This is associated with POST requests. Delete Permission: Allows the token to remove resources from the system. This is associated with DELETE requests. API Key expiry data determines the date after which the API Key will no longer be valid. This ensures that keys are not active indefinitely, adding an additional layer of security. If no expiry date is set, the key remains valid until manually revoked. API Key Group In the API Key Group tab, you can assign a specific tenant or device group to the API key. This defines which tenant or device group data the API key is allowed to access. If an API key is associated with a tenant, it can only access groups and devices within that tenant through API requests. If an API key is associated with a device group, it can only access devices within that group through API request. If no tenant or group is assigned to the API key the token will have access to all groups and devices within all available tenants. This setup allows fine-grained control over what devices the API key can interact with, ensuring that keys are restricted to specific tenants or\/and device groups when necessary.[\/vc_column_text][\/vc_column][\/vc_row]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\",\"url\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\",\"name\":\"API -\",\"isPartOf\":{\"@id\":\"https:\/\/www.gimasi.com\/#website\"},\"datePublished\":\"2025-04-01T12:46:46+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.gimasi.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GIOT Portal\",\"item\":\"https:\/\/www.gimasi.com\/?docs=giot-documentation\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.gimasi.com\/#website\",\"url\":\"https:\/\/www.gimasi.com\/\",\"name\":\"www2.gimasi.com\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.gimasi.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.gimasi.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.gimasi.com\/#organization\",\"name\":\"Gimasi SA\",\"url\":\"https:\/\/www.gimasi.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png\",\"contentUrl\":\"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png\",\"width\":170,\"height\":33,\"caption\":\"Gimasi SA\"},\"image\":{\"@id\":\"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.linkedin.com\/company\/gimasi-sa\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API -","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api","og_locale":"en_US","og_type":"article","og_title":"API -","og_description":"[vc_row][vc_column][vc_column_text css=&#8221;&#8221;] API Key Setup To access the API, you first need to create an authentication key within the system. Log in to your administrator tenant account and navigate to the Tenant page from the Administration menu. Select the API tab and click on the Create API key button. Enter a name, description, expiry date, and select a tenant whose data the API key will access. Choose the necessary permissions for the API key, then click Next. Important: Ensure to store the API Key securely, it will not be displayed again! Administrators can cancel the API key creation by clicking Cancel. API Key Settings After creating the API key, you can modify its name, description, permissions and expiry date in API Key Settings tab accessed through the Edit button. Ensure that the correct permissions are set; otherwise, the token will fail authentication if incorrect or no permissions are assigned. API Key permissions define which types of API calls the token can perform: Read Permission: Allows the API token to retrieve data from the system. This is associated with all GET requests. Write Permission: Allows the API token to modify existing data within the system. This is associated with PUT requests. Create Permission: Allows the token to create new resources within the system. This is associated with POST requests. Delete Permission: Allows the token to remove resources from the system. This is associated with DELETE requests. API Key expiry data determines the date after which the API Key will no longer be valid. This ensures that keys are not active indefinitely, adding an additional layer of security. If no expiry date is set, the key remains valid until manually revoked. API Key Group In the API Key Group tab, you can assign a specific tenant or device group to the API key. This defines which tenant or device group data the API key is allowed to access. If an API key is associated with a tenant, it can only access groups and devices within that tenant through API requests. If an API key is associated with a device group, it can only access devices within that group through API request. If no tenant or group is assigned to the API key the token will have access to all groups and devices within all available tenants. This setup allows fine-grained control over what devices the API key can interact with, ensuring that keys are restricted to specific tenants or\/and device groups when necessary.[\/vc_column_text][\/vc_column][\/vc_row]","og_url":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api","url":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api","name":"API -","isPartOf":{"@id":"https:\/\/www.gimasi.com\/#website"},"datePublished":"2025-04-01T12:46:46+00:00","breadcrumb":{"@id":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.gimasi.com\/?docs=giot-documentation\/api"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/api#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.gimasi.com\/"},{"@type":"ListItem","position":2,"name":"GIOT Portal","item":"https:\/\/www.gimasi.com\/?docs=giot-documentation"},{"@type":"ListItem","position":3,"name":"API"}]},{"@type":"WebSite","@id":"https:\/\/www.gimasi.com\/#website","url":"https:\/\/www.gimasi.com\/","name":"www2.gimasi.com","description":"","publisher":{"@id":"https:\/\/www.gimasi.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.gimasi.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.gimasi.com\/#organization","name":"Gimasi SA","url":"https:\/\/www.gimasi.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png","contentUrl":"https:\/\/www.gimasi.com\/wp-content\/uploads\/2025\/04\/cropped-gimasilogo.png","width":170,"height":33,"caption":"Gimasi SA"},"image":{"@id":"https:\/\/www.gimasi.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.linkedin.com\/company\/gimasi-sa\/"]}]}},"uagb_featured_image_src":{"full":false,"thumbnail":false,"medium":false,"medium_large":false,"large":false,"1536x1536":false,"2048x2048":false},"uagb_author_info":{"display_name":"admin","author_link":"https:\/\/www.gimasi.com\/?author=0"},"uagb_comment_info":0,"uagb_excerpt":"[vc_row][vc_column][vc_column_text css=\\&#8221;\\&#8221;] API Key Setup To access the API, you first need to create an authentication key within the system. Log in to your administrator tenant account and navigate to the Tenant page from the Administration menu. Select the API tab and click on the Create API key button. Enter a name, description, expiry date,&hellip;","comment_count":0,"_links":{"self":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/314","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=314"}],"version-history":[{"count":0,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/314\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/289"}],"prev":[{"title":"Platform Overview and Dashboard","link":"https:\/\/www.gimasi.com\/?docs=giot-documentation\/portal-login","href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/320"}],"wp:attachment":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=314"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=314"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}