3 ways software developers can validate APIs

software, APIs, spike, If This Then That (IFTTT) platforms, Automate.io, IFTTT, Integrately, Tray.io, Workato, test-driven development (TDD) methodologies, Postman, Katalon, RapidAPI, Parasoft, SmartBear ReadyAPI, Boomi, Jitterbit, MuleSoft, PMG, SnapLogic
Credit: Dreamstime

Here’s a situation I am certain many software developers have faced when building or enhancing a new application.

The product owner defines an epic and several features requiring integrations with a new SaaS application. She’s made several assumptions about what capabilities the SaaS platform exposes in their APIs and has baked these into workflow and front-end application requirements. She expects the agile development team to complete a spike, ideally in one sprint, to validate these assumptions.

The question is, how easy is it for the development team to perform this investigation and ideally implement proofs of concept that validate assumptions?

Keep in mind that these validations must go beyond reviewing the endpoints on what transactions and views they expose. They should also check data quality, consider performance, and ultimately determine what development work is needed to fulfill requirements using the available APIs. Developers should also review the authorisations required and other security considerations as part of this evaluation.

Can you perform this challenge in a sprint, ideally without writing too much code?

Since integrating with APIs is a common application and data integration requirement, development teams should consider using tools to help review capabilities and test assumptions. Organisations that integrate with many SaaS, enterprise, and other third-party tools should also consider integration platforms that can speed up development, provide robust integration capabilities, and also perform operational functions around the integrations.

Here are three different approaches to API validation.

What integrations do IFTTT platforms enable?

Suppose the requirement is to integrate with a commonly used SaaS platform. In that case, one simple approach is to review what actions and triggers If This Then That (IFTTT) platforms enable, what data is required to trigger the API, and what data types, formats, and quality it returns.

Zapier offers integration with more than 3,000 apps where triggers and actions can be reviewed and tested. Integrations can be simple and used to push new records from one app to another, or they can be more complex and leverage filters, paths, formatting, and other functions.

The latter steps are often necessary when a trigger in one app requires finding the right record and updating it in a second app. The format function also enables data cleansing and other data manipulations.

Zapier also offers tools to test and monitor integrations. These operational functions are very useful when validating more complex integrations and APIs where different scenarios trigger various types of actions.

Other IFTTT automation tools include Automate.io, IFTTT,Integrately, Tray.io, and Workato. These tools can help test and develop an API proof of concept as a rapid starting point. But development teams should also consider using these tools in production when developers can create, test, and operationalise the required integrations through them.

Use a test-driven development approach to validate APIs

What happens when the required integration is with a noncommercial third-party API or is an industry-specific platform that isn’t wired into IFTTT platforms? Or what if more complex integrations, workflow orchestrations, data manipulations, or data volumes make using IFTTT platforms less attractive?

Development teams might consider test-driven development (TDD) methodologies to validate and prototype with APIs. This approach asks development teams to construct unit tests and higher levels of orchestrated, automated, and continuous testing before using the API’s capabilities directly in composite services or applications.

TDD is a powerful approach when developing APIs and microservices because it defines and documents the expected uses and boundary cases. Test automation helps flag any changes to the service that might create downstream impacts.

The approach works equally well when consuming third-party APIs. Developers can use tools like Postman to import API specifications, understand the API, build test suites, and then integrate the tests into continuous integration/continuous delivery (CI/CD) pipelines and other devops tools. Other tools to review include Katalon, RapidAPI, Parasoft, and SmartBear ReadyAPI.

These tests not only help validate the APIs, but developers can also use them later for automated and continuous testing. In production, they can help validate if and when third-party API changes break tests and require review and fixes of any services and applications using them.

Use low-code integration platforms to build reusable gateways

What happens if you plan to integrate with multiple platforms, and the integrations need to be reusable in numerous services and applications? Maybe your organisation is customising employee onboarding applications, marketing tools, and field operations workflows that require integrating with HubSpot, Workday, SAP, or other platforms.

I spoke to Ed Macosky, head of products at Boomi, about the opportunities in trying to share data and enable workflow and collaborations with everyone in medium and large organisations. These organisations need more than validating APIs; they require a scalable integration process.

He expresses the challenge this way: “How can developers solve this end-to-end picture of connecting everyone to everything, like connecting all the data sources, understanding all the data within an organisation, integrating that data, developing services, creating user-driven workflows, and exposing it to front-end applications that engage users?”

Integration platforms such as Boomi come with connectors to common SaaS and enterprise platforms along with low-code tools to enable rapid development, testing, and deployment. Instead of creating point-to-point integrations, one integration can serve multiple downstream applications and composite services.

Other integration platforms include Jitterbit, MuleSoft, PMG, and SnapLogic. Application integration or Integration Platform as a Service (iPaaS) platforms differentiate on a wide range of capabilities, including ease of use, data management features, operational functions, and self-service options.

Using an integration platform is highly strategic for organisations that want to tailor experiences to different business needs and departmental workflows. For example, the onboarding application can be customised to only show basic steps for someone joining an operation in a specific role, whereas it may allow new technical hires to select equipment or sales reps to set travel preferences.

What’s important for developers to remember is that validating an API is just the first step in the integration journey. Developers must then create reusable, scalable, robust, and supportable integrations.

Doing this well requires plugging integrations into an operating environment designed to support integrations with the expected business service-level objectives. Integration and iPaaS platforms offer these options and can be highly beneficial to organisations looking to make integrations a core development and operational competency.

News Related

OTHER NEWS

Google, Amazon forced to patch DNS platforms after serious bug discovered

Cybersecurity researchers have disclosed a security issue that affected hosted DNS service providers and can be exploited to monitor incoming traffic and map the victim’s internal networks. At the recent ... Read more »

Best horror games 2021: the scariest games to play on console and PC

Looking for the best horror games? You’re in the right place. There are still a few more months to go before Halloween, but that’s no reason to overlook the top ... Read more »

After electric scooter, Ola wants to sell used cars online

Bengaluru: Ride-hailing startup Ola is likely to enter retailing of used cars, a segment that is growing fast as consumers look for affordable personal mobility amid the pandemic. The business ... Read more »

New Anti-Solar Storms Sun Modeling Could Predict Space Weather and Prevent Possible Global Internet Blackouts

Solar Storms were expected to hit Earth last July. However, the predictions of various scientists and other experts were incorrect since the space activity didn’t hit the planet. (Photo : ... Read more »

Windows 10 update brings its copy-and-paste feature to Android

Microsoft is set to give Android users a significant upgrade with a new update for its SwiftKey keyboard tool that allows users to copy and paste content between almost all ... Read more »

Apple to use new tech to see what photos you have in your iPhone

Apple will reportedly deploy a new technology to see what kind of photos you have in the Gallery of your iPhone to identify whether or not you are storing child ... Read more »

Hit the roads with confidence with a Rexing dash cam

Ever felt that a lot of people on the road at the moment seem to have forgotten how to drive while everything was locked down? You might be the most ... Read more »

Cybercriminals have small businesses in their crosshairs

When looking to steal data, cybercrime groups rarely care about the organization’s size, and as time goes by, the cost of these data breaches only rises. However, while large enterprises ... Read more »

Best customer feedback tools in 2021

The best customer feedback tools enable a simple way to collect useful data from customers to enable you to add value to their experience. The best customer feedback tools Click ... Read more »

5G coverage requires focusing on tangible benefits

The UK’s deployment of 5G continues to gather pace, with mobile providers offering the enhanced service to devices across a growing number of locations. Yet, despite increasingly frequent announcements from ... Read more »

Best Nintendo DS games: all the DS titles worth revisiting

Looking for the best Nintendo DS games? Whether you’re feeling nostalgic or keen to see if there are any games you might have missed out on over the years, we’re ... Read more »

Specifications of Realme Flash, ‘world's first Android phone with magnetic wireless charging support' surface online

Earlier this week, Realme introduced its MagSafe-like feature — called Realme MagDart — that offers support for a magnetic wireless charging system for its future phones. At the event, the ... Read more »

This ever-ready power station and solar panel are your ultimate power backup — and it's $500 off

TLDR: The combination of a HomePower One Backup Battery Power Station and the SolarPower One Portable Solar Panel can have you absolutely ready when the power goes out. One any ... Read more »

The best cheap VPN providers 2021

So you like the idea of getting a VPN, but you don’t particularly want to spend lots to get one? Thankfully, competition is so hot that the world’s top providers ... Read more »

Black Friday coffee machine deals 2021: what to expect this year

When it comes to buying a new coffee maker, Black Friday coffee machine deals are generally worth the wait. Plenty of popular coffee makers dropped to their lowest prices ever ... Read more »

NHS COVID-19 App Sees 43% Decrease in the Number of Alerts Among UK Residents

The NHS COVID-19 app in the United Kingdom has seen a significant decrease in the number of alerts sent by users. In just a week, the numbers have decreased by ... Read more »

The best Amazon Fire TV Stick VPN 2021

Amazon Fire Stick users reading this article won’t need us to explain what a handy little bit of kit they are – providing a platform to watch all your favorite ... Read more »

Contact-aware robot design

A novel method to represent robotic manipulators helps optimize complex and organic shapes for future machines. Read more »

This may be the most important piece of sun protection for kids

These are the only kinds of sunglasses that are ophthalmologist-approved Read more »

Google's new Nest Cams use AI to detect intruders and spot packages

Google today four new Nest cameras and a doorbell in an effort to simplify home security — and bring its strongest competition to Amazon’s Ring system yet. They also include ... Read more »

Microsoft Teams is getting a new feature called ‘Top Hits'

Microsoft is going to improve its search functionality with a new feature called Top Hits, as per a report by TechRadar. The Redmond-based tech giant has published a new entry ... Read more »

The most advanced Windows 10 users have something new to celebrate

Microsoft has rolled out an update for its PowerToys suite for Windows 10 that delivers a number of small but important improvements. The new version does not come bundled with ... Read more »

Amazon Great Freedom Festival Sale is Live: Here are some of the best deals on mobile phones

Amazon’s Great Freedom Festival is bringing several discounts to smartphones across different segments. Apart from discounts and offers, Amazon is also offering an additional 10 percent discount on transactions carried ... Read more »

Should I buy a Hisense TV? A look at the budget smart TV brand

It’s safe to say that we’re spoilt for choice when it comes to TV brands. We’ve got Samsung, Sony, LG, and plenty of others all vying to be the centerpiece ... Read more »

Apple sued in Texas over alleged patent infringement on digital signatures used for authentication

Altpass LLC has sued Apple in Texas over use of their security measures on iPhones Apple is being dragged to court in Texas, USA for alleged patent infringement. Altpass LLC ... Read more »

The Technology of Meat

(Photo : The Technology of Meat) Remember when people used a 3D printer to create little globs of plastic “somethings” that generally looked like they were about to melt? Well, ... Read more »

Google Nest Cam release date, news, and everything you need to know

Google has unveiled a new home security camera with facial recognition that, in a first for Google, is battery-powered. The Google Nest Cam (battery) replaces both the Google Nest Cam ... Read more »

Biden pushes for EVs to reach 50% in nationwide sales by 2030

During a rather historic meeting at the White House on Thursday, automakers, the United Autoworkers (UAW), and other leaders officially expressed their support to Biden administration’s plans to strengthen American ... Read more »

Uber losses widen as driver incentives rise along with trips, deliveries

Austin | Bengaluru: Uber Technologies Inc.’s losses widened in the April-June period as driver incentives hit revenue accrued from growth in number of trips and deliveries. The ride-hailing and food-delivery ... Read more »

[GadgetBattle] DJI Mavic Air 2 vs. DJI Air 2S Spec-by-Spec Comparison: Which Small Drone Suits You Better

DJI Mavic Air 2 and DJI Air 2S are two of the mid-range drones of the China-based tech giant. (Photo : by LOIC VENANCE/AFP via Getty Images) A DJI logo ... Read more »

Leaseweb Global expands its footprint in Canada with cloud hosting acquisition

Cloud services company Leaseweb Global is expanding its presence in the North American region by acquiring one of Canada’s popular cloud hosting providers. Founded in 1996 and previously part of ... Read more »

Halo Infinite impresses on Xbox Series X, as older consoles suffer

For those of you who’ll be playing Halo Infinite on anything other than an Xbox Series X/S (or PC), it seems the game doesn’t run so well on last-gen Xbox ... Read more »

Google's new Nest Cams and Doorbell keep recording even if Wi-Fi and power are out

Google has announced four new smart home cameras as it moves its home security offering into its second generation. The new product line-up includes the Nest Doorbell, Nest Cam, Nest ... Read more »

Google Nest Doorbell (battery) release date, price, and everything you need to know

The best video doorbells are a great way to ensure you never miss a delivery again, as they let you converse with whoever’s on your doorstep through your smartphone, even ... Read more »

Best Nintendo 3DS games: the most essential 3DS releases

On the hunt for the best Nintendo 3DS games? This guide is for you. The 3DS is now a whole decade old. Which means it might not be the latest ... Read more »

You can save big on the new Samsung Galaxy S21 at Verizon, Sprint and AT&T with these offers

— Recommendations are independently chosen by Reviewed’s editors. Purchases you make through our links may earn us a commission. If you’re on the hunt for a new phone, there are ... Read more »

Data privacy in China: Zhejiang province proposes rule to ‘destroy' personal data collected during emergencies

China’s eastern province of Zhejiang, which is leading the country in applying big data technology to administration, has drafted rules stipulating that personal data collected during a public emergency should ... Read more »

Elon Musk confirms his book is being written by Steve Jobs' biographer

For quite a while now Elon Musk has been talking about writing a book or a book on his life. Now, the Tesla CEO has revealed that the book is ... Read more »

Developers love Rust and Svelte, dread Angular and IBM Cloud, Stack Overflow

Credit: Dreamstime For coders younger than 18 years of age, online resources like videos and blogs are more important for learning the craft than books and school combined, according to ... Read more »

Microsoft details Windows 365 virtual desktop prices

Credit: Microsoft Microsoft has launched its Windows 365 service, revealing US-based prices for the virtual desktops that range between US$20 and $162 per user per month. In July, Microsoft announced ... Read more »