{"id":19942,"date":"2017-07-14T11:16:09","date_gmt":"2017-07-14T16:16:09","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=19942"},"modified":"2022-02-03T12:38:37","modified_gmt":"2022-02-03T18:38:37","slug":"account-api","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/devicehq\/account-api\/","title":{"rendered":"Account API"},"content":{"rendered":"<h3>Introduction<\/h3>\n<p>Release 3.0 of\u00a0DeviceHQ<sup>\u00ae<\/sup> will support a json-format, token-authorized Account API designed for automated access to account and device information to any user with a valid DeviceHQ account.<\/p>\n<h4>Prerequisites<\/h4>\n<p>To use the API it is necessary to have an enabled, valid DeviceHQ account. It is not necessary to own any MultiTech devices or have had any devices checked-in to the DeviceHQ server.<\/p>\n<p>In order to enable API access for their account information, users must generate an <b>Account API Key<\/b>, and enable API access.<\/p>\n<h4>Enabling API Access<\/h4>\n<p>To enable API access:<\/p>\n<ol style=\"padding-left: 30px;\">\n<li>Log in to <a href=\"https:\/\/devicehq.com\/\">devicehq.com<\/a> with manager-level access.<\/li>\n<li>Click on the user email in the upper right corner.<\/li>\n<li>Click on\u00a0<strong>Account Info\u00a0<\/strong>and then click\u00a0<strong>Edit.<\/strong><\/li>\n<li>Check\u00a0<strong>Account API Enabled<\/strong>.<\/li>\n<li>Click\u00a0<strong>Update Account\u00a0<\/strong>and return to the edit screen.<\/li>\n<\/ol>\n<h4>Generating API Keys<\/h4>\n<p>An account API key is like a password for your account on deviceHQ.com.\u00a0 The account API key (not the same as the account key) allows the API client to access the account with the same privileges as a manager-level user belonging to that account.<br \/>\nTo generate API keys:<\/p>\n<ol>\n<li>Log in to\u00a0<a href=\"https:\/\/devicehq.com\/\">devicehq.com<\/a>\u00a0with manager-level access.<\/li>\n<li>Click on the user email in the upper right corner.<\/li>\n<li>Click on\u00a0<strong>Account Info\u00a0<\/strong>and then click\u00a0<strong>Edit.<\/strong><\/li>\n<li>Click <strong>Generate New Account API Key<\/strong> (as needed).<\/li>\n<\/ol>\n<p>DeviceHQ generates new keys for access to the account API.<\/p>\n<p><strong>Notes:<\/strong><\/p>\n<ul>\n<li>MultiTech recommends you save the generated keys in a safe place, as they will not be displayed again as they are stored using a 1-way cryptographic hash algorithm.<\/li>\n<li>New keys may be generated at any time.<\/li>\n<li>Generating new keys will invalidate any key that had previously been generated.<\/li>\n<li>At any given time, only 1 client per account can have a session open.<\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<p style=\"padding-left: 30px;\"><a href=\"https:\/\/www.multitech.net\/developer\/software\/devicehq\/account-api\/account-api-authentication\/\">Account API &#8211; Authentication<\/a><\/p>\n<p style=\"padding-left: 30px;\"><a href=\"https:\/\/www.multitech.net\/developer\/software\/devicehq\/account-api-format\/\">Account API &#8211; Format<\/a><\/p>\n<p style=\"padding-left: 30px;\"><a href=\"%20https:\/\/www.multitech.net\/developer\/software\/devicehq\/account-api\/account-api-route\/\">Account API &#8211; Route<\/a><\/p>\n<p style=\"padding-left: 30px;\"><a href=\"https:\/\/www.multitech.net\/developer\/software\/devicehq\/account-api\/account-api-search-and-pagination\/\">Account API &#8211; Search and Pagination<\/a><\/p>\n<p style=\"padding-left: 30px;\"><a href=\"www.multitech.net\/developer\/software\/devicehq\/account-api-http-codes\/\">Account API &#8211; HTTP Codes<\/a><\/p>\n<p style=\"padding-left: 30px;\"><a href=\"https:\/\/www.multitech.net\/developer\/software\/devicehq\/account-api\/account-api-examples\/\">Account API &#8211; Examples<\/a><\/p>\n<p style=\"padding-left: 30px;\">\n","protected":false},"excerpt":{"rendered":"<p>Introduction Release 3.0 of\u00a0DeviceHQ\u00ae will support a json-format, token-authorized Account API designed for automated access to account and device information to any user with a valid DeviceHQ account. Prerequisites To use the API it is necessary to have an enabled, valid DeviceHQ account. It is not necessary to own any MultiTech devices or have had [&hellip;]<\/p>\n","protected":false},"author":2082,"featured_media":0,"parent":8979,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-19942","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/19942","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/2082"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=19942"}],"version-history":[{"count":18,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/19942\/revisions"}],"predecessor-version":[{"id":19963,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/19942\/revisions\/19963"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/8979"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=19942"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}