Consuming a Third-Party API in ASP.NET Core Web API Based on Conditions

Learn how to effectively filter API responses in ASP.NET Core Web API, focusing on consuming a `third-party API` based on specific conditions like `BranchType`.
---

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: ASP.NET Core Web API - how to consume third-party API based on condition

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Consuming a Third-Party API in ASP.NET Core Web API Based on Conditions

In today's interconnected world, applications often need to communicate with each other, and consuming third-party APIs has become a common practice. But what happens when you only need a specific subset of data from an API? This post will guide you through the process of consuming a third-party API in an ASP.NET Core Web API, and how to filter the response based on certain conditions.

The Challenge

You are tasked with integrating a third-party API into your ASP.NET Core-6 Web API project. The API in question provides details about various branches of a company. The provided API endpoint is as follows:

[[See Video to Reveal this Text or Code Snippet]]

[[See Video to Reveal this Text or Code Snippet]]

The response contains a list of branches, which includes information such as the branch name, number, type, and country.

However, you don't need all the data. Your requirement is to only consume the branches whose BranchType contains Human Resource or Production. Let's explore how to achieve this.

Implementing the Solution

Step 1: Data Classes Setup

You've defined the necessary classes to handle the branch data. Here’s a quick overview of your data classes:

Branch: Represents the branch entity.

BranchCreateUpdateDto: Data transfer object for creating or updating branches.

BranchResponse: The response structure that contains a list of branches.

BaseResponse: A generic response class that indicates success or failure.

Step 2: Service Interface and Implementation

Your service interface, IAdminBranchService, includes the method definition:

[[See Video to Reveal this Text or Code Snippet]]

Now we'll implement the actual data retrieval and filtering in the AdminBranchService.

Step 3: Consuming the API and Filtering Data

Here's how you can consume the API and filter the branches based on your criteria:

Make the API Call: Use an HttpClient to make an asynchronous request to your configured API endpoint.

Deserialize the Response: Convert the JSON response into your BranchResponse object.

Filter the Response: Use LINQ to filter branches based on the BranchType.

The updated CreateBranchAsync method in the AdminBranchService looks like this:

[[See Video to Reveal this Text or Code Snippet]]

Key Notes

Asynchronous Programming: Notice how I used await for asynchronous API calls. This ensures that your application remains responsive while waiting for the external API response.

Error Handling: Always implement try-catch to handle potential exceptions during API calls.

LINQ Filters: Use LINQ for straightforward and efficient data manipulation.

Conclusion

Consuming a third-party API in ASP.NET Core can be straightforward when you break it down into manageable steps. By setting up your data classes, implementing the necessary HTTP calls, and applying filters correctly, you can efficiently retrieve only the data you need. This approach ensures your application remains efficient and responsive while still integrating with external data sources.

By following the steps outlined in this post, you will improve your skills inworking with APIs, and ensure better data handling in your ASP.NET applications.