Webservice Manager

Webservice Manager

The Webservice Manager page is a tool designed to help developers and administrators keep track of their use of the InsideSales webservice. It is used to view access and error logs, add IP addresses to a whitelist, and generating a security token.

To use Webservice Manager page, you must enable the permission. To enable the Manage Webservice Link permission, follow these steps:

1. Go to the Administrative tab.
2. Click on the "Manage Permissions" link near the middle of the Site Settings section.
3. Click the Page Permission set you want to allow to allow to use the Webservice Manager.
4. Under the Admin section, click the "Link: Manage Webservice" checkbox.
5. Save the permission.

All users with that page permission should now be able to see the link to that page. Note that it requires that users are Admins to use the page.


Throttle Information

The total number of webservice calls you can make is determined by the number of CRM licenses in your billing account.

In the Throttle Information section, your company webservice usage is shown by billing account. Next to each billing account is the throttle information.

License Count - Total number of CRM licenses for this billing account.

Maximum Webservice Calls - Number of webservice calls that can be made per hour from users in this billing account.

Total Used - Total number of webservice calls made during the current time block.

In most situations the Maximum Webservice Calls will be more than enough. If you are reaching the limit, try reducing the number of webservice calls:

  • Use the webservice login only once when doing more than one call
  • Make good use of the built-in paging when you are getting a large number of objects. If you are making 5 webservice calls to getLeads at 500 leads each call, you may be able to reduce that to a single call.
  • Wait until you can do things in batches. If you have something that calls getDeals every 10 minutes,  you could change it to get leads every hour.

You may purchase additional webservice calls on the billing information page.


IP Restrictions

IP Restrictions are used to enhance the security of the webservices by restricting the IP addresses that can use it.

Most systems using the webservice will have a small number of known locations from which webservice calls are made. When active, the IP Restrictions prevent access to the webservice from IP addresses not on the list. While not required to use the InsideSales.com webservice, IP Restrictions provide another layer of security and are recommended in situations where you know what IP addresses will be using the webservice.

To set up IP Restrictions, you will need to make a list of all IP addresses that are allowed to use the webservice. Add them to the IP Restrictions list on the Webservice Manager page. When you have finished adding all IP addresses, click the "Enable" button in the IP Restrictions section. Note that if you leave out any IP addresses while the restrictions are active will stop that IP address from making webservice calls.


Security Token

Security Token - Allows you to generate, reset, and clear the webservice Security Token

The Security Token is a unique, secret code that is used when making calls to the InsideSales.com webservice. To use the webservice, you must first generate a security token using the "Generate Token" button on the Webservice Manager page. The main purpose of the security token is to prevent unauthorized access to your database.

When a SOAP or REST client attempts to login and authenticate to the webservice, a security token is sent along with a username and password. Once the token has been verified the username and password are checked before logging the user in. Using a token allows the webservice to know that a given user is allowed to use the webservice.

Note - Generating, resetting, and clearing the token affect the entire company; webservice requests must be accompanied by the same security token.

Generate Token - Generates a new security token.

Email Token - Emails you the existing security token.

Reset Token - Clears, generates, and emails you a new security token.

Clear Token - Clears the security token. Once a token has been cleared, you must generate a new token before making any webservice calls.


Current Hour Summary

The Current Hour Summary section shows the logs the webservice has generated over the last hour.

Call Totals

The Call Totals summary shows which webservice methods have been called the most over the last hour. This can help you determine what areas you are using the webservice for the most. The download button will allow you to download the past 30 days of webservice call logs in CSV format. The downloaded log is comprehensive data (not summary data), so it will show you each of the webservice calls in detail, such as when the call was made, which IP address, the method being called, etc.

 

Logins

The Logins summary shows which IP addresses have used the webservice in the past hour and the total number of webservice calls made from each. For systems that are making webservice calls from more than one IP address, this is helpful for determining where most of the calls are coming from. The download button in the Logins summary is a download of the summary data as shown, in CSV format.

 

Error Log

The Error Log summary shows which errors have been generated in the past hour, sorted by which errors are occurring the most often. This is particularly helpful while developing your code to interact with the webservice, but it can also be useful for noticing when errors occur that your code doesn't catch. The download button in the Error Log summary downloads a CSV file of all errors encountered in the last 30 days in detailed format, including error codes and when the errors occurred.

Products  |  Services  |  Resources  |  Customers  |  Events  |  Partners  |  About Us
Insider Blog  |  Developers  |  Terms  |  Policy  |  Site Map  |  News  |  Awards  |  Careers  |  Partners