Simplify Application Integration with the REST API Browser (Beta)

By |2020-06-01T06:43:04+00:00June 1st, 2020|

With a number of cloud applications, mobile apps, and IoT devices emerging on the digital horizon, businesses are discovering valuable uses for these streaming sources. On average, a business uses 1,935 apps. The challenge, however, is to integrate these multiple endpoints with other enterprise systems to create consolidated views that can be shared with stakeholders and partners.

HTTP based REST APIs act as digital glue that enables applications and servers to interact with each other to enhance product functionality and data mobility. APIs solve challenges related to connectivity by standardizing syntax and communication methods. Hence, facilitating organizations to connect the dots in multi-channel enterprise architecture and create a well-connected ecosystem.

What Challenges Do APIs Solve?

Several companies are opting for cloud-based systems, such as Hubspot, Sage CRM, etc. to manage their enterprise assets. Business metrics, which may have been hosted on in-house databases and various file formats, are now locked behind third-party applications and web interfaces.

Business users need this information to make data-driven decisions, and APIs make that possible. They simplify information access by specifying the interaction protocol for the software components. Furthermore, APIs are used by third-party integration tools to fetch data. They can be integrated with other source systems to process business queries or consolidate dashboards.

A survey conducted by RapidAPI shows an upward trend in API consumption, with 66.5% survey respondents expecting to use more APIs in 2020. Companies are aggressively investing in exposing their services and assets through APIs, and businesses need a simplified way to retrieve data and unlock the information trapped in APIs.

The REST API Browser in Astera Centerprise makes that possible by simplifying REST API consumption, enabling on-premise enterprise systems to connect with external applications in a secure way.

Introducing the REST API Browser (Beta)

Astera Centerprise 8 features an intuitive REST API Browser that enables connectivity to popular business applications via single-step authentication to make HTTP calls. It decouples data from the point of origin to make it consumable, independent from the source system.

To use an API, the user needs to perform a one-time set up for the API connection in the Import API screen. Then, the REST API Browser populates all the HTTP requests (GET, PUT, POST, DELETE, PATCH) present in that specific API. Users can access and integrate these calls in their dataflows simply by dragging-and-dropping the object from the Browser.

rest api integration integration using rest api

There are two ways to use the REST API Browser in Centerprise:

  1. Within the scope of the integration project (requires creating a new project or opening an existing one)
  2. Outside the scope of the integration project (requires creating a shared REST API connection)

One of the major benefits of the REST API Browser is that it generates the developer-accessible features of an OAS-compliant API. This means that importing an API will populate the API endpoint and resource information automatically into the Browser. This visual documentation simplifies back end consumption and saves valuable development time.

Using the REST API C, users can import public, private, and custom APIs into their integration flows:

  • Public APIs: These are open APIs that are built on top of public services and information. They can be accessed and modified by third-party tools and external partners using API keys and security tokens. Marketers, for example, can access population data from the US census bureau and integrate it with their marketing information to identify the regions where their product is most popular.
  • Private APIs: These APIs enclose an organization’s backend data and applications in an interface that can be used within the organization or shared with partners. Businesses use private APIs to improve access and enhance process automation internally. These APIs give organizations greater control over their information assets by customizing access. For instance, Amazon mandated its employees to share data via APIs to promote collaboration and enable faster integration.

Importing public and private APIs requires JSON/YML file or URL. As for the APIs that don’t follow the Open API protocol, they can be imported using the base URL and API name.

Let’s illustrate the functionality of the REST API Browser with a use case:

An online pet store wants to segment their inventory based on pets’ availability for sale. The store uses the private API of the inventory system, via the REST API Browser, to access the inventory data in Centerprise’s integration project. The data is standardized and sorted into two distinct database tables based on the availability status:

  • Data related to available pets is sent to the marketing team, which they use to design new campaigns and track their efforts.
  • The list of sold pets is routed to a separate database table, which is further integrated with sales data and delivered to the finance team to calculate revenue.

This dataflow is run once a month. When the status of a pet updates from ‘available’ to ‘sold’ on the website, the database is updated too.

To configure API connection in Astera Centerprise, go through this step-by-step guide on our documentation platform.

Figure 1: Importing API in the REST API Browser - rest api integration integration using rest api

Figure 1: Importing API in the REST API Browser

Once the API is imported, Centerprise automatically creates two files in the project:

  • A .capi file, which includes all the HTTP calls present in that API, visible in the Browser
  • A .Sact or shared connection file, which contains the Base URI and authentication protocols
Figure 2: The left panel shows the API layout in the REST API Browser and the right panel shows a breakdown of the project files

Figure 2: The left panel shows the API layout in the REST API Browser and the right panel shows a breakdown of the project files

In this case, the store will be using the GET request to retrieve data from the website. This is done simply by dragging-and-dropping the Find Pets by Status object from the Browser onto the dataflow designer.

Figure 3: Using the GET method through the API Browser

Figure 3: Using the GET method through the REST API Browser

Expanding the nodes will show the output layout of the accessed resource. The Response Info presents information related to the status codes in response to a request. The JSON Body, on the other hand, displays the data-related information.

Once the website data is fetched, it is cleaned by applying Data Cleanse transformation, and saved in distinct SQL tables based on their availability status, using the Route transformation.

Figure 4: Database Properties Screen

Figure 4: Database Properties Screen

The database tables are configured with Insert and Update options. Therefore, after the first run only updated records are propagated to the database tables.

Figure 5: API integration dataflow for the pet store

Figure 5: API integration dataflow for the pet store

To execute the same process outside the scope of the project, the user will have to drag-and-drop REST API Connection and REST API Client objects from the toolbox. The REST API Connection will have to be configured with base URL and authentication details for data consumption.

Figure 6: Accessing the REST API Client and REST API Connection from the Toolbox

Figure 6: Accessing the REST API Client and REST API Connection from the Toolbox

Currently, Centerprise supports four authentication protocols for REST APIs:

OAuth2: The user has to request access token, in addition to the client ID, username, and password to access APIs with OAuth2 protocol.

API Key: The resource owner generates an API key for the client application.

Basic Authentication: APIs with basic authentication require only username and password. At runtime, the API key is automatically passed to the endpoint header or query when processing request.

Bearer Token: The resource owner associates a JSON Web Token (JWT) to the client application. When the API is accessed, the JWT is passed along all the calls on the server. To access APIs with bearer token, the user needs username, password, and token URL.

Figure 7: Authentication protocols supported in Centerprise

Figure 7: Authentication protocols supported in Centerprise

The REST API Browser made it easier for the pet store to retrieve and clean website data to optimize their business processes – all with zero coding efforts.

This use case illustrated processing a GET call in a dataflow. To learn in detail about how to make POST, PUT, and DELETE requests through the REST API Browser, go through our documentation.

Exploring the Business Side of the REST API Browser

Evolution of APIs has opened up exciting opportunities for businesses. Here’s how you can utilize this feature and leverage APIs for operational efficiency:

Automate API Integrations

The REST API Browser eliminates the need to create third-party integrations from scratch with its simple single-step configuration. The feature can be augmented with Astera Centerprise’s workflow automation to enable integration repeatability, cutting downtime and manual efforts in executing processes, and accelerating project delivery.

For example, a logistics company wants to automate the customer onboarding process. They use a web-based portal to input customer data, which includes shipping details and product information. When a client registers on the web-based portal, the REST API Browser fetches their data through the HTTP GET method, runs it through standardization and validation rules, and adds into the company database.

Every time a new buyer orders through the portal, the information is automatically propagated to the database in near real-time, and the workflow runs on a loop.

Access Data Easily and Reduce Time-To-Market

By simplifying communication with internal and external apps and systems present in your enterprise stack, REST API Browser enables you to get more value out of your existing business assets. It completes a circuit that fosters a digital business that is primed to scale.

Let’s take the example of a software consulting firm that stores their enterprise data in different master databases. To unify this data and improve accessibility throughout the organization, the firm wants to consolidate these disparate data points.

They use NetSuite for product data and Salesforce for customer data. In addition, these endpoints need to connect with Marketo, which has leads data. All these endpoints need to be tied up by integrating a sales lead in Marketo, to an opportunity in Salesforce to a product in NetSuite.

By consuming API endpoints of NetSuite and Marketo through the ng a built-in Salesforce connector, they were able to unify all this data. Streamlining data access enables them to guarantee fluid information delivery and quickly turnaround customer requests.

Synchronize Enterprise Systems

Synchronizing constantly changing data with other enterprise systems ensures data consistency across multiple endpoints. The REST API Browser helps manage the flow of information from one system to another while retaining data quality.

For instance, a business management software provider wants to leverage this feature to optimize its ticket management system. They connect to Zendesk and JIRA using REST APIs. The flow automatically picks up defect tickets from Zendesk through the GET method and updates bug tracking in JIRA using the POST call.

Synchronizing these systems streamlines communication between the development and support teams.

Near Real-Time Reporting          

Up-to-date information of daily operations can lead to informed decisions based on data rather than experience. Real-time reporting is especially beneficial for businesses that have several moving parts, such as a complex manufacturing process or lengthy marketing, and sales cycle.

For instance, an e-commerce company pulls raw lead data for lead management from a marketing automation app, Hubspot. This data is enriched with Google Analytics data and segmented with respect to demographics, geographic area, company name, and company website. Once retrieved, this data is cleansed by referencing against Salesforce data, and routed to a visualization platform, PowerBI, for real-time reporting.

This enables the e-commerce provider to keep tabs on their leads in real-time and optimize the experience for leads that are not converting.

In this way, the REST API Browser can help you connect lines of businesses, partners, and customers to any internal or external system, and make their data available across disparate organizations.

rest api integration integration using rest api

Want to find out how this feature can streamline data accessibility and API integration for your business? Download the trial version of Astera Centerprise and explore this feature first-hand!

Note: Currently, the REST API Browser (Beta) is available for users to evaluate the component’s stability and functionality for a range of use cases before we premiere the production version in the next release of Centerpirse. Help us improve this feature by providing us your feedback and suggestions.