If you’re new to API Development, some of the terminology used in our manuals and videos may be a bit unfamiliar to you. Rather than making you guess as to what we mean, let’s define some terms used throughout

  1. Application Pool - This is the first thing that you MUST setup to deploy a Thriftly Server. Your application executable is loaded multiple times by Thriftly as a “pool” of processes that can respond to API calls. An application pool uses only one application executable, but it can be loaded multiple times so that many API calls can be processed concurrently.

  2. Service - Your application pool can expose (or make public) one or more Services. A service is a logical grouping of API calls. Oftentimes an application will breakup it’s API into multiple services based on what those API calls do. So for instance an application might have a Customer Service that has calls to add customers, edit them, delete them and find them. Another service within the same application could allow for the creation/editing/finding of Orders.

  3. Endpoint - An endpoint is the unique combination of the IP address, port, and name that an Application Pool exposes it’s Service(s) at. An Application Pool may have multiple Endpoints, and an Endpoint exposes all of the Service(s) published in that Application Pool.

  4. Endpoint URL - This refers to the specific URL that an endpoint is exposed at. If you’re using a Gateway, this URL will be publicly available over the internet. If you’re not using a Gateway, that URL might or might not be private to your internal network depending on your network configuration. An Endpoint URL may refer to either the URL of all of your Services or it could refer to the URL of a specific Service.

  5. Gateway - The Gateway is a secure server out on the internet that your local server talks to which allows you to publish your API out onto the internet without having to fiddle with firewall configurations or IP setup. When you choose to enable the Gateway for your Endpoint, the URL of that endpoint will change to a secure but publicly available URL accessible from anywhere on the internet. hosts servers throughout the world so that you can publish your API to a Gateway near you making your API as fast as possible.

If there are more terms you’d like to see specifically defined or expanded upon, please reply to this post and we’ll update it with more information.