Building an API: A guide to best practices

Aug 23, 2017

Building an Application Programming Interface (API) is an important step towards scalability in a tech product’s life cycle. An API allows other programs to interface with your code, bringing about new opportunities for other businesses to integrate with your own through code.

By building an API, organisations can leverage other businesses to connect into their given product, creating synergies and galvanising the tech product as a true platform upon which other businesses can be built. It has been said that Facebook and Twitter were only truly established as platforms when other businesses could leverage themselves on the platform using their APIs. It’s what separated eBay from Craigslist, or Amazon from any other e-commerce site out there.

However, in the tech world APIs can be fraught with danger. There are many horror stories in this world of development, where businesses spend millions on creating something nobody will use, or give their client base an unscalable product. To avoid these, here are some best practices to use in building out your API.

1. Don’t delay development with a business case

Almost always, when building a scalable solution as an API, commercial justification in the early days can be tough. There aren’t a lot of clear revenue benefits, and if the business needs to justify building an API with a business case, it probably doesn’t need one. If the board and CEO have instinctively stated they need an API, this should be done with a lean scope and rough timeline. These things take time, and it can be very hard to know what is needed until way down the line.

2. Be consistent with your ‘failures’

When building something as difficult as an API, use every iteration as a learning opportunity. If the business manages to build the right development platform from the start, chances are that you’re probably heading down the wrong path. APIs need failures to be refined, evolve expanded on. In order to be refined, they almost always need lessons to be learned from. These learning opportunities need to happen consistently through every iteration, so be consistent with mistakes to generate the right lessons to be built upon in the future.

3. APIs are used in every way the user wants, not the way you want

If a customer says they intend to use your API for a use case that doesn’t fit your original bill, just run with it. Unless it is detrimental to your business, an API is a canvas for others to build upon. A canvas doesn’t get to say what art is built upon it, but it simply grants the opportunity for art to be made. By seeing things outside the box, through the eyes of the user, you can see your product being used to a greater extent than you first thought.

4. This is not a revenue opportunity, but a growth opportunity

Finally, it is important to recognise that an API will quite often result in another business being able to derive revenue apart from yours. Don’t take this personally. It isn’t lost revenue for your business a lot of the time (think Farmville on Facebook), but rather a way for you to cement your business in the marketplace.

If your business is ready to scale out, and welcome the prospect of other businesses being able to interface with your code, an API may be the best thing for you to do. By taking it on as a growth opportunity, learning from failure and not setting a guideline with a business case, the business may be able to welcome the weird and wonderful ways other businesses may interface with yours.

Online courses for upskilling
By Pamela Distapan 08 May, 2024
Discover the importance of upskilling in today's job market. Learn how free courses can enhance your CV and advance your career. Read more on S2M.
Employee wellness programs
By Pamela Distapan 17 Apr, 2024
Discover how prioritising mental health support in the workplace can attract and retain top talent. Learn actionable ways to enhance employee wellness and create a healthier work environment.
Two women having a conversation at work
By Pamela Distapan 02 Apr, 2024
Discover the latest trends in performance reviews and how HR and recruitment professionals are spearheading innovative changes in the workplace. From continuous feedback to skill-based assessments, explore new approaches to evaluating and improving employee performance.
More Posts
Share by: