{"id":8229,"date":"2023-08-10T22:00:28","date_gmt":"2023-08-10T22:00:28","guid":{"rendered":"https:\/\/www.use-snip.com\/kb\/?post_type=ht_kb&#038;p=8229"},"modified":"2023-09-02T17:19:20","modified_gmt":"2023-09-02T17:19:20","slug":"web-api-login","status":"publish","type":"ht_kb","link":"https:\/\/www.use-snip.com\/kb\/knowledge-base\/web-api-login\/","title":{"rendered":"Web API, Login"},"content":{"rendered":"<p>Authorized users can log into the <span style=\"color: #0000ff;\"><strong>SNIP<\/strong><\/span> Web API with a simple Login page.\u00a0 The Web API provides an alternative way to manage and administer your <span style=\"color: #0000ff;\"><strong>SNIP<\/strong><\/span> NTRIP Caster using any common browser.\u00a0 In order to use the <a href=\"https:\/\/www.use-snip.com\/downloads\/snip_web\/\" target=\"_blank\" rel=\"noopener\">Web API<\/a>, the <a href=\"https:\/\/www.use-snip.com\/plug-ins\/\" target=\"_blank\" rel=\"noopener\">Plug-In module<\/a> must be present and active.<\/p>\n<p><a href=\"https:\/\/www.use-snip.com\/kb\/wp-content\/uploads\/2023\/08\/SNIP_LogOn2.png\"><img loading=\"lazy\" decoding=\"async\" class=\"alignright wp-image-8852 size-full\" src=\"https:\/\/www.use-snip.com\/kb\/wp-content\/uploads\/2023\/08\/SNIP_LogOn2.png\" alt=\"\" width=\"518\" height=\"718\" srcset=\"https:\/\/www.use-snip.com\/kb\/wp-content\/uploads\/2023\/08\/SNIP_LogOn2.png 518w, https:\/\/www.use-snip.com\/kb\/wp-content\/uploads\/2023\/08\/SNIP_LogOn2-216x300.png 216w, https:\/\/www.use-snip.com\/kb\/wp-content\/uploads\/2023\/08\/SNIP_LogOn2-36x50.png 36w, https:\/\/www.use-snip.com\/kb\/wp-content\/uploads\/2023\/08\/SNIP_LogOn2-320x444.png 320w\" sizes=\"auto, (max-width: 518px) 100vw, 518px\" \/><\/a><\/p>\n<h2>How<\/h2>\n<p>In order to log into the Web API you must use either the <strong>Admin<\/strong> account and password, or a <strong>Customer Account<\/strong>, realm name, and password.\u00a0 These are created and managed by the Caster Operator.<\/p>\n<p>The login process is similar to any other web site.\u00a0 The user enters a name (in this case the Customer or Staffs primary <strong>eMail account<\/strong> &#8211; and this is NOT case sensitive) and the assigned <strong>Password<\/strong>. The Customer must also enter the <strong>Realm<\/strong>, which is the nickname you have assigned to that customer. [See below for a shortcut.]\u00a0 If the credentials are accepted, a session is established and the user is taken to the Web API <a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/web-api-top-page\/\">top page<\/a>.\u00a0 This page is the launching point for all other operations the user account can perform.\u00a0 It is described further <a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/web-api-top-page\/\">here<\/a>.<\/p>\n<h2>Where<\/h2>\n<p>The login page can be reached at the URL of your caster with &#8220;<strong>\/SNIP::Login<\/strong>&#8221; appended.\u00a0 For example, if your Caster is located myNtrip.example.com on port 2101, you would enter: myNtrip.example.com:2101\/SNIP::Login\u00a0 If your Caster does not have a registered domain name, you would enter the IP address in its place, just as you do for NTRIP Client connections.<\/p>\n<h2>Modes<\/h2>\n<p>A unique aspect of the <span style=\"color: #0000ff;\"><strong>SNIP<\/strong><\/span> Web API is that each email account has <strong>two<\/strong> different passwords.<\/p>\n<ul>\n<li>There is a &#8220;<strong>read-write<\/strong>&#8221; password which is allowed to change (edit, create, delete) various settings that the User Account is authorized to manage, as well as view them.<\/li>\n<li>And there is a &#8220;<strong>read-only<\/strong>&#8221; password that allows viewing various key details, but does not allow editing or deleting them.<\/li>\n<\/ul>\n<p>You can create both of these or just one, or none as suits the operational need of your Caster. This is managed in the Customer Accounts dialog (menu command: <strong>Setup<\/strong> \u21d2 <strong>Manage Customer Accounts&#8230;\u00a0 <\/strong>then select the customer you wish to edit).\u00a0 See <a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/adding-customer-accounts\/\" target=\"_blank\" rel=\"noopener\">this page<\/a> for further details.<\/p>\n<p>As the <span style=\"color: #0000ff;\"><strong>SNIP<\/strong><\/span> operator, you may elect to provide this right to selected <a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/adding-customer-accounts\/\" target=\"_blank\" rel=\"noopener\">Customer Accounts<\/a> as you see fit (and any\u00a0 <a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/using-viewing-staff-accounts\/\" target=\"_blank\" rel=\"noopener\">Staff member<\/a> accounts you create for them).\u00a0 For example, you might decide not to allow any Customer Accounts to use the Web API, providing it only for your own support staff to use.\u00a0 You might provide &#8220;read-only&#8221; rights to selected customers so they can troubleshoot the User Accounts (NTRIP Clients) that they manage.\u00a0 You might allow selected Customer Accounts to be able to add new User Accounts, or new Base Stations.\u00a0\u00a0 You can also preset the number Users or Base each user is allowed to create (if any).\u00a0 This topic is discussed in more depth in <a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/adding-customer-accounts\/\" target=\"_blank\" rel=\"noopener\">this article<\/a>.<\/p>\n<p>The eMail used for the Admin account (which is under the<a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/the-preferences-dialog\/\" target=\"_blank\" rel=\"noopener\"> Preferences dialog<\/a>, (menu: <strong>Edit<\/strong> \u21d2 <strong>Preferences<\/strong> ) can edit, delete, and see reports about all users and bases, regardless of any ownership by Customer Accounts.\u00a0 Adding and managing Staff members for the Admin account can also be found there.\u00a0 But if the Admin account (or a staff member) is logged on in &#8220;read-only&#8221; mode it cannot change the information it sees.<\/p>\n<h2>Entering the Realm, <em>a hint<\/em><\/h2>\n<p>You can enter the realm (when used) on it&#8217;s own line, or as part of the eMail address.\u00a0 Just precede the eMail address with the realm and add <strong>&#8220;:&#8221;<\/strong> as a separator.<\/p>\n<p>For example; if you email is &#8220;myEmail@myDomain.com&#8221; and your realm is &#8220;myCaster&#8221;\u00a0 you could enter both of these in the email line as:\u00a0 &#8220;myCaster:myEmail@myDomain.com&#8221;\u00a0 when you log in. When this format is used, the content of the realm entry is ignored.<\/p>\n<p>By entering the data this way, many browsers will offer to remember the credentials for you the next time you log in.<\/p>\n<h2>On\/Off<\/h2>\n<p>The core Web API functionality is set in the <a href=\"https:\/\/www.use-snip.com\/kb\/knowledge-base\/the-preferences-dialog\/\" target=\"_blank\" rel=\"noopener\">Preferences dialog<\/a>, (menu: <strong>Edit<\/strong> \u21d2 <strong>Preferences<\/strong> ) where you can enable\/disable it and control a number of basic settings concerning the default web page contents.<\/p>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Authorized users can log into the SNIP Web API with a simple Login page.\u00a0 The Web API provides an alternative way to manage and administer your SNIP NTRIP Caster using any common browser.\u00a0 In order to use the Web API, the Plug-In module must be present and active. How In [&hellip;]<\/p>\n","protected":false},"author":13,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"_exactmetrics_skip_tracking":false,"_exactmetrics_sitenote_active":false,"_exactmetrics_sitenote_note":"","_exactmetrics_sitenote_category":0,"footnotes":""},"ht-kb-category":[418],"ht-kb-tag":[505,438,539,518],"class_list":["post-8229","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-reports","ht_kb_tag-customer-accounts","ht_kb_tag-login","ht_kb_tag-staff-accounts","ht_kb_tag-web-api"],"_links":{"self":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8229","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/comments?post=8229"}],"version-history":[{"count":14,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8229\/revisions"}],"predecessor-version":[{"id":8859,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb\/8229\/revisions\/8859"}],"wp:attachment":[{"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/media?parent=8229"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=8229"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.use-snip.com\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=8229"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}