Helping Developers Integrate Deployed APIs Into New Applications

Note

If you deployed your API as a gRPC service, skip to the Deploying Your API as a gRPC Service section for instructions on connecting with your service.

After you’ve successfully deployed your API, you’ll want to give your application developers the information they need to start making calls to your APIs (and previous application) from within new applications. To do so:

  1. Open the Thriftly Configurator (Windows Start menu > Thriftly Deployment Server > Thriftly Admin). Then, select the application and endpoint you want to provide info on.

Selecting an endpoint in the Thriftly Configurator

  1. If your application is not already running, select the configurator_run_button_2 button in the Thriftly Configurator toolbar to run your application.

  2. Select the Endpoint Info button.

The Endpoint Info button

Your endpoint’s info launches in your web browser. Provided your application is running, from this URL, your application developers can see:

  • Your endpoint’s URL location.

  • The URL location of the services (APIs) included within your endpoint.

  • A Test API link that allows your developers to test those services (using the instructions near the end of the Testing Your Thriftly API section).

An endpoint information web page

But that’s not all. By selecting one of your services (by clicking on the blue bar that includes its name), developers can see a variety of additional information about that service, including:

  • The calls included in that service, as well as the parameters each call accepts.

  • Any structs included in that service.

  • Any error handling included in that service.

A service information web page

This information should be all your developers need to get started calling your Thriftly APIs from within new applications. However, some developers might benefit from seeing detailed examples of Thriftly API construction and consumption. If your developers want to see example Thriftly APIs called and consumed from within example applications, you should send them to our Thriftly API demo.

Accessing the Thriftly API Demo

If your application developers want to see real Thriftly APIs in action, embedded within a web page, direct them to our demo at Thriftly.io/demo. There, your developers can see:

  • The structure of sample APIs created from our sample PropertyTracker application. The demo allows developers to see sample APIs constructed from .NET/C#, Visual Basic, Java, and DataFlex applications.

  • How to test these sample APIs.

  • Examples of how to consume Thriftly APIs from within applications built using a variety of standard programming languages.

  • The data returned by the sample APIs using a variety of request-response formats.

We encourage you to send your application developers to this demo and have them explore how Thriftly APIs are built, how to test them, and how to consume them.