How It Works
The WebServius Engine, combined with web-based interfaces for you and your API users, form a complete API management solution
How does WebServius work?
WebServius acts as a proxy between your bare functionality and your API users.
We also offer a proxyless API management solution for certain scenarios where latency is a concern. Click here for more information.
The first step in launching your API is to create an API wrapper around your functionality, and then host it on your servers at a private, secure location that will only be known to you and WebServius. If you need help with any part of this process, from initial API design to implementation to hosting, see our API Design Assistance page.
The WebServius Engine then creates a public endpoint for the API, through which your users will access your functionality. This endpoint is fully managed and protected. For every request that arrives at the public endpoint, WebServius does a quick yet rigorous check to make sure that the API caller is legitimate, is authorized by you, is not exceeding their quota, and has sufficient balance (in the case of a pay-per-use API).
Once a call has been verified, it is logged and then forwarded to your servers. Once they respond, the response is then forwarded back to the API caller. Upon successful call completion, if the call is to a pay-per-use API, your balance is automatically credited and the API caller's balance is automatically charged for the price of the call.
How do API users sign up and pay for access?
WebServius handles all aspects of developer signup and billing - all you need to do is to link to us.
WebServius provides a page where developers can subscribe to your API. Typically, you need to add a button or a link on your website saying "Subscribe to our API", and link it to the subscription page provided by WebServius. If you define multiple subscription plans (for example, a free trial and a paid premium version), developers will be able to choose among the plans. There is a possibility of co-branding the subscription page.
 |
Once a developer has subscribed to your API, they get access to the WebServius portal for subscribers. From there, they can conveniently pay for API access using widely-available payment mechanisms such as PayPal (including credit card payments), as well as view their API keys, usage history, and other information.
In a more advanced scenario, you may already have a user management mechanism that you would like to reuse for API access. WebServius can accommodate this as well - please contact us for details.
Where are API settings (like pricing) configured?
WebServius offers a web-based control panel to manage API quotas, pricing, users and more.
With WebServius, you are always in complete control. Through our easy-to-use web-based interface, you can instantly change API quotas, pricing plans, and other relevant rules and settings.
You can also manage individual API subscribers and API keys, including the ability to shut them down if necessary, or to give more favorable terms to a particular subscriber.
Finally, our reporting and analytics components always give you insight into your API's usage patterns and financial performance. You can quickly discover your most active users, your most used services, your most popular subscription plans, and your revenue from paid APIs.
Next Steps