Understanding API usage

Understanding how Application Programming Interface (API) calls work and how they're charged is crucial for web development. This knowledge is essential for selecting the right hosting plan and building a cost-effective solution for your project.

How APIs work

An API is a set of rules that allows different software applications to communicate and share data. APIs serve as an intermediary, defining the data formats and methods for interaction. This enables developers to connect their applications to other services, typically by making HTTP requests to get the information they need.

For example, a social media app might use an API to access a payment processing service or location data. APIs are essential to modern software development because they enable different systems to work together, allowing for the creation of more powerful and integrated solutions.

Inbound API calls

Inbound API calls are requests to your Insites instance from an external server or client, similar to how a user accesses a webpage. However, these calls only request raw data. As such, they don't count toward your API usage limits. Instead, they are measured against your bandwidth allocation, which is a separate and generous allowance on all plans.

You can monitor your bandwidth usage directly within the Insites Console and Insites Instance Admin (IIA). If your application has high usage, you can utilize plan overages to accommodate increased traffic before needing to upgrade to the next plan. This system allows for flexible scaling as your project's needs grow.

Outbound API calls

When your server instance communicates with an external server to create, retrieve, update, or delete data, it's considered an outbound API call. These are also known as CRUD operations. Each of these calls, along with its response, counts toward your hosting plan's usage limit.

Webhooks

When using webhooks, remember that they operate over the HTTP Protocol. Unlike traditional API calls, webhooks do not count toward your monthly API call quota. However, it's important to know that their data transfer is included in your monthly bandwidth usage.

Instance plan usage

There are three distinct hosting options available for Insites. It's crucial to have a clear understanding of the specific inclusions in your chosen plan and to proactively monitor them to prevent any unforeseen expenses.

Additionally, if you depend on regular updates from external services, it's advisable to thoroughly assess the integration of your applications with third-party systems.

Checking your usage

Best practices for high usage applications