{"id":24254,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/gettoken-1\/"},"modified":"2025-02-17T09:59:22","modified_gmt":"2025-02-17T17:59:22","slug":"gettoken-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/","title":{"rendered":"get_token"},"content":{"rendered":"

This command retrieves a token from an ExtraView instance, in order that the token may be used in subsequent API calls without the need for these subsequent API calls to send the password in clear text.\u00a0 The protocol used to generate the token and to apply this is termed OAuth2.\u00a0 When a valid token is generated, it has an expiry date and time, based upon the value in the behavior setting named\u00a0OAUTH2_TOKEN_LIFETIME_SECONDS.\u00a0 After the token expires, a new token must be requested, again using the\u00a0get_token\u00a0<\/code>command.\u00a0 If an API request is made using an expired token, the server treats the call as an invalid sign on and access is refused.<\/span><\/p>\n

SYNTAX<\/h3>\n

https:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action?\u00a0<\/span>
\nuser_id=username\u00a0<\/span>
\n&password=password\u00a0<\/span>
\n&statevar=get_token\u00a0<\/span>
\n[&ev_send_xml=false | true]<\/span><\/p>\n

NOTES<\/h3>\n

The token is returned as plain text, unless the parameter\u00a0ev_send_xml<\/span>\u00a0is set to\u00a0true<\/code>, in which case the token is returned within an XML format.<\/p>\n

If two factor authentication is turned on for the site, this will cause a problem when a user attempts to use token-based access.\u00a0 To avoid this issue, a security permission key named USER.EXCLUDE_2FA must be turned on for the user role.\u00a0 Following that, a new prompt on the user’s personal options screen will allow for the user to bypass the 2FA and directly access the API.<\/p>\n

EXAMPLES<\/h3>\n

Example 1:<\/strong>\u00a0Send the URL:<\/p>\n

https:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action?<\/span>user_id=my_user_id&password=my_password&statevar=get_token<\/span><\/p>\n

This returns:<\/p>\n

Token:x3o4xNX8xYm4gRE5YrtLPq3Bybtav9Xao8VBI1oPtz8
\nType:Bearer
\nLifetime:3600
\nExpiration Date:2020-07-02 18:39:48.818 -0700
\nScope:read write<\/code><\/p>\n

Example 2:<\/strong>\u00a0Send the URL:<\/p>\n

https:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action?<\/span>user_id=bsmith&password=bill&statevar=get_token&ev_send_xml=true<\/span><\/p>\n

This returns:<\/p>\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
\n<\/code><access_token>
\n<value> ayBNRrDElFvyv7yrTlT2rAiOkCtth1Ez9M7cQyh1hHc <\/value>
\n<type> Bearer <\/type>
\n<lifetime> 3600 <\/lifetime>
\n<Expiration Date> 2020-07-02 18:39:48.818 -0700 <\/lifetime>
\n<scope> read write <\/scope>
\n<\/access_token><\/span><\/p>\n

At this point in time, the\u00a0type\u00a0<\/code>and\u00a0scope\u00a0<\/code>within the returned data have no meaning.<\/p>\n

Once a valid token is returned, you may use this in subsequent API calls, with the following being an example – note there is no User ID or Password parameters:<\/p>\n

https:\/\/www.myserver.com\/evj\/ExtraView\/ev_api.action? access_token=ayBNRrDElFvyv7yrTlT2rAiOkCtth1Ez9M7cQyh1hHc&statevar=fields&include_fields=y<\/code><\/p>\n


<\/p>\n","protected":false},"excerpt":{"rendered":"

This command retrieves a token from an ExtraView instance, in order that the token may be used in subsequent API calls without the need for these subsequent API calls to send the password in clear text.\u00a0 The protocol used to generate the token and to apply this is termed OAuth2.\u00a0 When a valid token is…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24223,"menu_order":45,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24254","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nget_token - Product Documentation<\/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:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"get_token - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"This command retrieves a token from an ExtraView instance, in order that the token may be used in subsequent API calls without the need for these subsequent API calls to send the password in clear text.\u00a0 The protocol used to generate the token and to apply this is termed OAuth2.\u00a0 When a valid token is...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-17T17:59:22+00:00\" \/>\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:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/\",\"name\":\"get_token - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-17T17:59:22+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Application Programming Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"get_token\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"get_token - Product Documentation","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:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/","og_locale":"en_US","og_type":"article","og_title":"get_token - Product Documentation","og_description":"This command retrieves a token from an ExtraView instance, in order that the token may be used in subsequent API calls without the need for these subsequent API calls to send the password in clear text.\u00a0 The protocol used to generate the token and to apply this is termed OAuth2.\u00a0 When a valid token is...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-17T17:59:22+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/","name":"get_token - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-17T17:59:22+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/gettoken-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Application Programming Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/application-programming-interface-1\/"},{"@type":"ListItem","position":4,"name":"get_token"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24254","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24254"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24254\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24223"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24254"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}