{"id":309,"date":"2025-04-01T12:41:16","date_gmt":"2025-04-01T12:41:16","guid":{"rendered":"http:\/\/www2.gimasi.com\/?docs=api\/supported-api"},"modified":"2025-04-01T12:41:16","modified_gmt":"2025-04-01T12:41:16","slug":"supported-api","status":"publish","type":"docs","link":"https:\/\/www.gimasi.com\/?docs=api\/supported-api","title":{"rendered":"Supported API"},"content":{"rendered":"

Supported API\u00a0<\/strong><\/h3>\n
    \n
  1. \n

    API REST (HTTP\/HTTPS)<\/strong><\/p>\n

      \n
    • \n

      Based on HTTP GET, POST, PUT, DELETE <\/strong>requests<\/p>\n<\/li>\n

    • \n

      Anwers in JSON<\/strong><\/p>\n<\/li>\n

    • \n

      Usable by any application with network access
      \n<\/span>Example:<\/span><\/p>\n

      \n
      <\/div>\n
      http<\/pre>\n
      <\/div>\n
      GET https:\/\/api.example.com\/devices\/LM123456\/data\n<\/pre>\n<\/div>\n<\/li>\n<\/ul>\n<\/li>\n
    • \n
      API MQTT (Pub\/Sub)<\/strong><\/p>\n
        \n
      • \n
        Based on MQTT<\/strong> (Message Queuing Telemetry Transport) protocol<\/p>\n<\/li>\n
      • \n
        Ideals for real time communications with a low\u00a0bandwidth consumption<\/span><\/p>\n<\/li>\n
      • \n
        The device publishes data to a topic, and other clients can subscribe to receive it<\/p>\n<\/li>\n
      • \n
        Example:<\/p>\n
        \n
        plaintext<\/div>\n
        <\/div>\n
        Topic: levelmeter\/LM123456\/data
        \nPayload: {\\\"temperature\\\": 23.4, \\\"motion_detected\\\": true}
        \n<\/code><\/div>\n<\/div>\n<\/li>\n<\/ul>\n<\/li>\n<\/ol>\n
        \n
        Authentication and Security<\/h3>\n
        APIs use authentication tokens to ensure security and controlled access.
        \nExample of authentication with Bearer token:<\/p>\n
        \n
        http<\/div>\n
        GET https:\/\/api.example.com\/devices\/LM123456\/data
        \nAuthorization: Bearer YOUR_ACCESS_TOKEN
        \n<\/code><\/div>\n<\/div>\n
        \n
        Examples of Endpoint API REST<\/strong><\/h3>\n
        1. Get the latest device data<\/strong><\/p>\n
        \n
        http<\/div>\n
        GET \/devices\/{device_id}\/data
        \n<\/code><\/div>\n<\/div>\n
        Answer JSON<\/strong><\/p>\n
        \n
        json<\/div>\n
        {<\/span>
        \n\\\"device_id\\\"<\/span>:<\/span> \\\"LM123456\\\"<\/span>,<\/span>
        \n\\\"timestamp\\\"<\/span>:<\/span> 1711532400<\/span>,<\/span>
        \n\\\"temperature\\\"<\/span>:<\/span> 23.4<\/span>,<\/span>
        \n\\\"motion\\\"<\/span>:<\/span> true<\/span><\/span>,<\/span>
        \n\\\"battery_level\\\"<\/span>:<\/span> 78<\/span>
        \n}<\/span>
        \n<\/code><\/div>\n<\/div>\n
        2. Set a Threshold Alarm<\/strong><\/p>\n
        \n
        http<\/div>\n
        POST \/devices\/{device_id}\/alerts
        \nContent-Type: application\/json
        \n<\/code><\/div>\n<\/div>\n
        Body JSON<\/strong><\/p>\n
        \n
        json<\/div>\n
        {<\/span>
        \n\\\"type\\\"<\/span>:<\/span> \\\"temperature\\\"<\/span>,<\/span>
        \n\\\"threshold\\\"<\/span>:<\/span> 50<\/span>,<\/span>
        \n\\\"action\\\"<\/span>:<\/span> \\\"send_alert\\\"<\/span>
        \n}<\/span>
        \n<\/code><\/div>\n<\/div>\n
        3. Check Battery Status<\/strong><\/p>\n
        \n
        http<\/div>\n
        GET \/devices\/{device_id}\/battery
        \n<\/code><\/div>\n<\/div>\n
        Answer<\/strong><\/p>\n
        \n
        json<\/div>\n
        {<\/span>
        \n\\\"battery_level\\\"<\/span>:<\/span> 78<\/span>,<\/span>
        \n\\\"status\\\"<\/span>:<\/span> \\\"OK\\\"<\/span>
        \n}<\/span><\/code><\/div>\n<\/div>\n","protected":false},"featured_media":0,"parent":298,"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-309","docs","type-docs","status-publish","hentry"],"yoast_head":"\nSupported 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\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Supported API -\" \/>\n<meta property=\"og:description\" content=\"Supported API\u00a0 API REST (HTTP\/HTTPS) Based on HTTP GET, POST, PUT, DELETE requests Anwers in JSON Usable by any application with network access Example: http GET https:\/\/api.example.com\/devices\/LM123456\/data API MQTT (Pub\/Sub) Based on MQTT (Message Queuing Telemetry Transport) protocol Ideals for real time communications with a low\u00a0bandwidth consumption The device publishes data to a topic, and other clients can subscribe to receive it Example: plaintext Topic: levelmeter\/LM123456\/data Payload: {"temperature": 23.4, "motion_detected": true} Authentication and Security APIs use authentication tokens to ensure security and controlled access. Example of authentication with Bearer token: http GET https:\/\/api.example.com\/devices\/LM123456\/data Authorization: Bearer YOUR_ACCESS_TOKEN Examples of Endpoint API REST 1. Get the latest device data http GET \/devices\/{device_id}\/data Answer JSON json { "device_id": "LM123456", "timestamp": 1711532400, "temperature": 23.4, "motion": true, "battery_level": 78 } 2. Set a Threshold Alarm http POST \/devices\/{device_id}\/alerts Content-Type: application\/json Body JSON json { "type": "temperature", "threshold": 50, "action": "send_alert" } 3. Check Battery Status http GET \/devices\/{device_id}\/battery Answer json { "battery_level": 78, "status": "OK" }\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.gimasi.com\/?docs=api\/supported-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\",\"url\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\",\"name\":\"Supported API -\",\"isPartOf\":{\"@id\":\"https:\/\/www.gimasi.com\/#website\"},\"datePublished\":\"2025-04-01T12:41:16+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-api#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.gimasi.com\/?docs=api\/supported-api\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.gimasi.com\/?docs=api\/supported-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\"}]},{\"@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":"Supported 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","og_locale":"en_US","og_type":"article","og_title":"Supported API -","og_description":"Supported API\u00a0 API REST (HTTP\/HTTPS) Based on HTTP GET, POST, PUT, DELETE requests Anwers in JSON Usable by any application with network access Example: http GET https:\/\/api.example.com\/devices\/LM123456\/data API MQTT (Pub\/Sub) Based on MQTT (Message Queuing Telemetry Transport) protocol Ideals for real time communications with a low\u00a0bandwidth consumption The device publishes data to a topic, and other clients can subscribe to receive it Example: plaintext Topic: levelmeter\/LM123456\/data Payload: {\"temperature\": 23.4, \"motion_detected\": true} Authentication and Security APIs use authentication tokens to ensure security and controlled access. Example of authentication with Bearer token: http GET https:\/\/api.example.com\/devices\/LM123456\/data Authorization: Bearer YOUR_ACCESS_TOKEN Examples of Endpoint API REST 1. Get the latest device data http GET \/devices\/{device_id}\/data Answer JSON json { \"device_id\": \"LM123456\", \"timestamp\": 1711532400, \"temperature\": 23.4, \"motion\": true, \"battery_level\": 78 } 2. Set a Threshold Alarm http POST \/devices\/{device_id}\/alerts Content-Type: application\/json Body JSON json { \"type\": \"temperature\", \"threshold\": 50, \"action\": \"send_alert\" } 3. Check Battery Status http GET \/devices\/{device_id}\/battery Answer json { \"battery_level\": 78, \"status\": \"OK\" }","og_url":"https:\/\/www.gimasi.com\/?docs=api\/supported-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","url":"https:\/\/www.gimasi.com\/?docs=api\/supported-api","name":"Supported API -","isPartOf":{"@id":"https:\/\/www.gimasi.com\/#website"},"datePublished":"2025-04-01T12:41:16+00:00","breadcrumb":{"@id":"https:\/\/www.gimasi.com\/?docs=api\/supported-api#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.gimasi.com\/?docs=api\/supported-api"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.gimasi.com\/?docs=api\/supported-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"}]},{"@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":"Supported API\u00a0 API REST (HTTP\/HTTPS) Based on HTTP GET, POST, PUT, DELETE requests Anwers in JSON Usable by any application with network access Example: http GET https:\/\/api.example.com\/devices\/LM123456\/data API MQTT (Pub\/Sub) Based on MQTT (Message Queuing Telemetry Transport) protocol Ideals for real time communications with a low\u00a0bandwidth consumption The device publishes data to a topic, and…","comment_count":0,"_links":{"self":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/309","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=309"}],"version-history":[{"count":0,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/309\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=\/wp\/v2\/docs\/298"}],"wp:attachment":[{"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=309"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.gimasi.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=309"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}