{"id":8230,"date":"2022-06-21T14:00:01","date_gmt":"2022-06-21T14:00:01","guid":{"rendered":"https:\/\/www.use-snip.com\/kb\/?post_type=ht_kb&p=8230"},"modified":"2022-06-24T17:41:44","modified_gmt":"2022-06-24T17:41:44","slug":"web-api-top-page","status":"publish","type":"ht_kb","link":"https:\/\/www.use-snip.com\/kb\/knowledge-base\/web-api-top-page\/","title":{"rendered":"Web API, Top Page"},"content":{"rendered":"

This article describes the content of the Web API services and the Top Page in greater detail.<\/p>\n

The Web API Plug-In<\/a> provides a way to perform daily management of your Caster remotely using any browser.\u00a0\u00a0 This provides two immediate advantages.\u00a0 First, you can access SNIP<\/strong><\/span> to get status reports and manage user connections and base stations from anywhere, including your cell phone while in the field.\u00a0 Second, you no longer need allow someone to be logged onto the SNIP<\/span><\/strong> host machine in order to do this.\u00a0\u00a0 So your tech support staff can now access key controls and information in SNIP<\/strong><\/span> but not have access to the host machine itself or to various core Caster settings.<\/p>\n

If you resell time on your Caster, or you allow some of your your Customer accounts to manage their own User Accounts<\/strong> and \/ or Base Stations<\/strong>, the Web API Plug-In provides further features you will want to use.\u00a0 For each Customer account you can enable the use of the Web API Plug-In in either a read-write<\/em> or read-only<\/em> mode of use. [In fact, because each account has two passwords assigned to it, you can do both.]\u00a0 You can set the number of users and base that the account is allowed to create and manage. The customer accounts you setup in this way can then create, manage, and troubleshoot their own NTRIP Client connections.<\/p>\n

The Top Page<\/h3>\n

\"\"<\/a><\/p>\n

 <\/p>\n

When you first login<\/a> to the Web API you are presented with a top page listing all the major operations your account is allowed to perform. For example, when using a read-only<\/em> account you are allowed to show various detailed reports about Users and Bases; but are not allowed to create \/ edit \/ delete the content in any User or Base entry.<\/p>\n

 <\/p>\n

 <\/p>\n

 <\/p>\n

The top page is divided into five sections as follow<\/p>\n

The first section has some basic reports about the Caster<\/strong> (such as as the SNIP::STATUS report).<\/p>\n

\"\"<\/a><\/p>\n

The second section deals with User Accounts<\/strong>.\u00a0 Here you can show, edit, create and delete User Accounts that are assigned to your Customer Account.<\/p>\n

\"\"<\/a><\/p>\n

The third section shows Base stations<\/strong> connecting with methods other than as a Push-In<\/a> type.\u00a0 This section is shown only to Admin users.<\/p>\n

\"\"<\/a><\/p>\n

The fourth section shows Base station connections and Reservations using the Push-In<\/strong> connection type.\u00a0 Here you can show, edit, create and delete the Push-In Reservation that are assigned to your Customer Account. [Again, the Admin account sees everything.]<\/p>\n

\"\"<\/a><\/p>\n

The fifth section show IP connections<\/strong>.\u00a0 Here you can show reports on how each IP has been used.\u00a0 This section is shown only to Admin users.<\/p>\n

\"\"<\/a><\/p>\n

A final section shows the same information about general Caster usage as the Up Time<\/a> report<\/p>\n

\n

 <\/p>\n

Transversal through the Web API Pages<\/h3>\n

When you first login<\/a> to the Web API you are presented with a top page listing all the major operations your account is allowed to perform. For example, when using a read-only<\/em> account you are allowed to show various detailed reports about Users and Bases; but are not allowed to create \/ edit \/ delete the content in any User or Base entry.<\/p>\n

\"\"<\/a><\/p>\n

In the diagram above the major steps are shown graphically from left to right (click to enlarge).\u00a0 After a successful login, the top page is shown.\u00a0 This is composed of five major sections.<\/p>\n

The first section has some basic reports about the Caster<\/strong> (such as as the SNIP::STATUS report).<\/p>\n

The second section deals with User Accounts<\/strong>.\u00a0 Here you can show, edit, create and delete User Accounts that are assigned to your Customer Account.<\/p>\n