DX Heroes logo
#sdk
#developer-experience
#developer-portal
#design

When Speed Matters: Why Investment into Faster Integrations Pays Off in the Long Run

Length: 

8 min

Published: 

January 19, 2023

When Speed Matters: Why Investment into Faster Integrations Pays Off in the Long Run

Many digital products offer APIs to their customers, promising to make their lives easier and their products better. The quality of those APIs ranges from bad to great, and the API is often one of the factors that help a customer decide to pick your product.

But it is not only about the quality of the API itself. It matters just as much what resources you give your potential customers so they can integrate your product with theirs. How fast they can do that can be the difference between success and failure for a business. When integration is quick, you onboard customers fast and grow your revenue with them.

Faster integration also makes it easier to scale up: to handle rising demand and expand your customer base.

The speed of integration defines costs and drives revenue growth

A successful integration needs both you and your customer in the process, and each side has roles to play.

On your side, the roles you need to fill to win the customer are:

  • a Sales Engineer to build the relationship with the client and explain what your product brings,
  • a Support Engineer to answer all their questions and help their team solve any issue they hit.

On the customer's side, they need to involve:

  • a Senior Software Engineer to assess the technical side of your product and estimate how much time and effort the integration will take,
  • Software Engineers to do the implementation itself.

Imagine two clients that meet the same criteria. In one case the integration finishes in a month. In the other it takes six months.

| | 1-month integration | | 6-month integration | | | --- | --- | --- | --- | --- | | | time in man-days | cost | time in man-days | cost | | You | | | | | | Sales Engineer | 1 | $614 | 6 | $3684 | | Support Engineer | 4 | $1258 | 24 | $7547 | | | | | | | | Your customer | | | | | | Senior Software Engineer | 1 | $634 | 6 | $3803 | | Software Engineer | 20 | $9310 | 120 | $55860 | | | | | | | | Total | 26 | $11816 | 156 | $70894 |

Note: All calculations are for demo purposes only and may vary based on different rates. Salary information was taken from GlassDoor, and all time estimates are approximate, based on possible role involvement for a given duration of integration.

The longer an integration runs, the more it costs per client, because you have to keep all the roles on both sides engaged for longer.

Delivered integrations compound over time while your company's operating cost stays the same ($214,987 in revenue versus $16,537). You not only generate more revenue faster. The more clients you onboard, the wider the word spreads.

So a longer integration costs you more money and also makes you miss out on revenue growth that would otherwise build up over time.

Differences between business and technical decision makers

Businesspeople usually choose a product that fits their needs and budget. A product website is great for introducing them to the benefits and explaining what they get. Videos or demo sessions are another good way to show your product is right for them. In some companies, executives also decide based on internal politics. It is always easier to pick a product the company already uses than to bring in a new one and go through the approval process.

Technical experts work alongside the businesspeople. They review the technical side of the product they want to integrate, check how fast the implementation will be, and estimate how much time and money to allocate. They usually do not care about product benefits or marketing ploys. They cut to the chase and focus on what they need to get a quick estimate and enough insight. The best way to help them is to put all the technical details on a separate page.

"34% of sales opportunities lost as the direct result of developer influence."

Luke Kilpatrick, DevRelCon San Francisco

Blog Article Illustration Image

What slows down the integration of your customers

Documentation that is insufficient or not publicly available

Documentation is often not publicly available, and that is a major headache for customers who want to use your product. Without docs, it is hard to judge the full value of a product or tell whether it fits. Worse, if the documentation is hard to find or vague once found, customers are even less likely to invest in something they are unsure about. As an established business, make your documentation easy to reach, so developers can quickly find everything they need and make an informed decision about your product.

It is impossible to give the API a quick try

Understanding how an API works can be hard, especially when time is short. The best way to learn what it does is to spend time in the documentation, read example responses and code snippets, or explore how the real API behaves in an API sandbox. That also makes the technical review easier for developers.

APIs that do not follow best practice

APIs that ignore best practices are a nuisance for developers. Mixed letter casing, nested data, and custom abbreviations cause confusion and frustration, and they become a huge roadblock when someone is trying to learn the ins and outs of an API. Poor documentation makes it worse and forces developers to spend more time and effort before they can fully use the API.

It is essential that APIs follow accepted standards to keep the experience pleasant.

Custom implementation of all API calls

Implementing API calls can eat a lot of time and money, depending on the complexity of the integration. The main factor is whether you have all the tools needed for the implementation. If you do not provide them, it can take much longer than expected. When companies invest in these resources upfront, they save money, simplify the process, and get better outcomes.

How to remove stumbling blocks and speed up integrations

Article Image Blocks

Provide guides that describe the implementation

To help customers learn your APIs quickly, give them a Quick Start Guide. Show them what they need before they start, how to navigate your documentation, and how to get everything running. Then point them to guides for advanced features, and use real-world scenarios that show comprehensive functionality and the value it brings to your clients.

Describe your API in the OpenAPI standard to use its full potential

Many APIs are described in the OpenAPI Specification (OAS), the most popular open-source framework for specifying and developing APIs.

It is a powerful language that lets developers describe the structure and operations of their APIs efficiently. With the OAS, they can create interactive API documentation with accurate descriptions of every endpoint.

You can import the OAS into API testing tools such as Postman and Insomnia, then test the endpoints and check that they work correctly.

Follow API best practices

Following the best practices for working with APIs removes confusion and frustration for your customers, and standardization makes the implementation simple and fast.

It also helps customers get started with your product without wasting time figuring out how things work.

On top of that, use consistent naming for endpoints and operations, document error responses, and provide examples. Consistency is the key to a smooth experience.

Provide a sandbox and tools to facilitate implementation

A sandbox environment lets customers try your API and get familiar with it before they commit. It also speeds up development by allowing faster experimentation and bug fixing.

You can also provide tools such as SDKs, libraries, frameworks, and code snippets that let customers write custom code faster and keep their implementations consistent. That makes working with your API smoother and more efficient.

Create a dedicated section with all the resources for the technical audience

Give the technical community a separate place with all the resources they need for a successful integration.

Your website or developer portal should include everything: tutorials, getting-started guides, sample code snippets, troubleshooting tips, FAQs, and other documentation about using your API. This makes it easier for developers to find and use what they need, and it shows you are serious about a high-quality API service.

Conclusion

API integration gets easier and cheaper when you prepare the right resources: guides and documentation, the OAS, API best practices, a sandbox and tools to help with development, and a dedicated section on your website with everything in one place. All of these steps speed up the process and make it easier for customers to implement your API.

Even the most thorough documentation will not solve every problem that comes up during implementation. That is why customer support matters for a successful integration, with helpful resources and quick, reliable answers to any question or issue. When you streamline API integrations and back them with excellent support, your API delivers on its full potential.

Word-of-mouth also helps spread awareness of your product and reaches more users. It has proven far more effective than paid advertising, and it is an excellent way to win more customers. Put these strategies together and your API integrations stay successful and cost-effective for you and your customers alike.

You might also be interested in:

Let us help you simplify your API integration. Contact us today and get more out of your product. We look forward to hearing from you.

Want to stay one step ahead?

Don't miss our best insights. No spam, just practical analyses, invitations to exclusive events, and podcast summaries delivered straight to your inbox.