{"id":333,"date":"2025-04-01T13:29:04","date_gmt":"2025-04-01T13:29:04","guid":{"rendered":"http:\/\/www2.gimasi.com\/?docs=api\/supported-api\/use-cases-api"},"modified":"2025-04-01T13:29:04","modified_gmt":"2025-04-01T13:29:04","slug":"use-cases-api","status":"publish","type":"docs","link":"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api","title":{"rendered":"Use Cases API"},"content":{"rendered":"

Main API Endpoints<\/strong><\/h2>\n

The GIoT API<\/strong> provides a flexible and secure way to interact with connected devices, configure settings, and retrieve real-time data. Below are the primary API endpoints:<\/p>\n

Authentication & Security<\/strong><\/h3>\n
    \n
  • \n

    Endpoint:<\/strong> \/api\/auth\/login<\/code><\/p>\n<\/li>\n

  • \n

    Method:<\/strong> POST<\/code><\/p>\n<\/li>\n

  • \n

    Description:<\/strong> Authenticate users via OAuth2 to generate access tokens for secure API communication.<\/p>\n<\/li>\n<\/ul>\n

    Device Commands & Configuration<\/strong><\/h3>\n
      \n
    • \n

      Endpoint:<\/strong> \/api\/device\/{device_id}\/command<\/code><\/p>\n<\/li>\n

    • \n

      Method:<\/strong> POST<\/code><\/p>\n<\/li>\n

    • \n

      Description:<\/strong> Send commands to a specific IoT device, such as changing reporting intervals or triggering remote actions.<\/p>\n<\/li>\n<\/ul>\n

      Sensor Data Retrieval<\/strong><\/h3>\n
        \n
      • \n

        Endpoint:<\/strong> \/api\/device\/{device_id}\/data<\/code><\/p>\n<\/li>\n

      • \n

        Method:<\/strong> GET<\/code><\/p>\n<\/li>\n

      • \n

        Description:<\/strong> Fetch real-time sensor data, including temperature, movement, and battery status.<\/p>\n<\/li>\n<\/ul>\n

        Geofence & Alarm Rules<\/strong><\/h3>\n
          \n
        • \n

          Endpoint:<\/strong> \/api\/geofence\/{geofence_id}\/update<\/code><\/p>\n<\/li>\n

        • \n

          Method:<\/strong> POST<\/code><\/p>\n<\/li>\n

        • \n

          Description:<\/strong> Update geofence parameters and set rules for location-based alerts.<\/p>\n<\/li>\n<\/ul>\n","protected":false},"featured_media":0,"parent":309,"menu_order":0,"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-333","docs","type-docs","status-publish","hentry"],"yoast_head":"\nUse Cases 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=api\/supported-api\/use-cases-api\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Use Cases API -\" \/>\n<meta property=\"og:description\" content=\"Main API Endpoints The GIoT API provides a flexible and secure way to interact with connected devices, configure settings, and retrieve real-time data. Below are the primary API endpoints: Authentication & Security Endpoint: \/api\/auth\/login Method: POST Description: Authenticate users via OAuth2 to generate access tokens for secure API communication. Device Commands & Configuration Endpoint: \/api\/device\/{device_id}\/command Method: POST Description: Send commands to a specific IoT device, such as changing reporting intervals or triggering remote actions. Sensor Data Retrieval Endpoint: \/api\/device\/{device_id}\/data Method: GET Description: Fetch real-time sensor data, including temperature, movement, and battery status. Geofence & Alarm Rules Endpoint: \/api\/geofence\/{geofence_id}\/update Method: POST Description: Update geofence parameters and set rules for location-based alerts.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-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=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api\",\"url\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api\",\"name\":\"Use Cases API -\",\"isPartOf\":{\"@id\":\"https:\/\/www.gimasi.com\/#website\"},\"datePublished\":\"2025-04-01T13:29:04+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.gimasi.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\",\"item\":\"https:\/\/www.gimasi.com\/?docs=api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Supported API\",\"item\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Use Cases 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":"Use Cases 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=api\/supported-api\/use-cases-api","og_locale":"en_US","og_type":"article","og_title":"Use Cases API -","og_description":"Main API Endpoints The GIoT API provides a flexible and secure way to interact with connected devices, configure settings, and retrieve real-time data. Below are the primary API endpoints: Authentication & Security Endpoint: \/api\/auth\/login Method: POST Description: Authenticate users via OAuth2 to generate access tokens for secure API communication. Device Commands & Configuration Endpoint: \/api\/device\/{device_id}\/command Method: POST Description: Send commands to a specific IoT device, such as changing reporting intervals or triggering remote actions. Sensor Data Retrieval Endpoint: \/api\/device\/{device_id}\/data Method: GET Description: Fetch real-time sensor data, including temperature, movement, and battery status. Geofence & Alarm Rules Endpoint: \/api\/geofence\/{geofence_id}\/update Method: POST Description: Update geofence parameters and set rules for location-based alerts.","og_url":"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api","url":"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api","name":"Use Cases API -","isPartOf":{"@id":"https:\/\/www.gimasi.com\/#website"},"datePublished":"2025-04-01T13:29:04+00:00","breadcrumb":{"@id":"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.gimasi.com\/?docs=api\/supported-api\/use-cases-api#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.gimasi.com\/"},{"@type":"ListItem","position":2,"name":"API","item":"https:\/\/www.gimasi.com\/?docs=api"},{"@type":"ListItem","position":3,"name":"Supported API","item":"https:\/\/www.gimasi.com\/?docs=api\/supported-api"},{"@type":"ListItem","position":4,"name":"Use Cases 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":"Main API Endpoints The GIoT API provides a flexible and secure way to interact with connected devices, configure settings, and retrieve real-time data. Below are the primary API endpoints: Authentication & Security Endpoint: \/api\/auth\/login Method: POST Description: Authenticate users via OAuth2 to generate access tokens for secure API communication. Device Commands & Configuration Endpoint: \/api\/device\/{device_id}\/command…","comment_count":0,"_links":{"self":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/333","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=333"}],"version-history":[{"count":0,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/333\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/309"}],"wp:attachment":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=333"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=333"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}