10 Mistakes to Avoid When Building Your API

10-mistakes-to-avoid-when-building-your-api

In October, I gave a talk at API World called “10 Mistakes to Avoid When Building an API,” which was a compilation of mistakes and missteps the HelloSign engineering team made while building our API. It was a hit!

But wait, why would we want to share mistakes?

Our engineering team has embraced the company values of “Transparency” and “Constant Improvement.” We regularly hold post-mortems to brainstorm ways to fix, improve, learn, and grow. This talk was actually a result of many post-mortems that were boiled down to a handy list of not-so-obvious lessons that others might be able to benefit from.

Below are the mistakes and lessons covered in the talk at API World:

More

3 Questions to Answer When Integrating the HelloSign API

top-3-things-to-look-at-when-integrating-the-hs-api-02

I’m a senior part of HelloSign’s API support team, so I see a lot of different API use cases. Each new customer brings a unique set of variables to the table. But despite the differences per customer case, there a few core questions that unfailingly come up. These questions need to be answered before we can get the ball rolling.

We thought it would be helpful to add a top-level overview of some of the core components of our API with some of the basic questions that need to be asked as you plan your integration.

This post will be geared slightly towards a more technical audience. We also have a helpful post about the “6 Steps For Getting Started With the HelloSign API” for non-technical folks.

The top three questions to ask as you’re planning your integration are:

  1. Who is creating my document?
  2. Where do I want the signers to go when signing?
  3. How should I structure my requests for fiscal efficiency?

More

Recharge Your Dev Team with a Bug Squash

BugSquash_v2

If you’re a developer, you likely spot (and ignore) irksome bits in your code or product regularly. Perhaps it’s an excessively long if-block or a border offset by 1 pixel too many. Maybe you manually run through 5 steps every week to get your test database just right.

We let these annoyances slide because we might not have time to fix them. We also understand that what seems small isn’t always a quick nip-tuck fix.

Last year, the HelloSign engineering team started holding a quarterly Bug Squash to clean up these exact types of issues. Like the name implies, it’s a two-day event to fix small bugs but we also use the time to make workflow enhancements, perform housekeeping, create developer tooling, fix broken windows, and tinker with small projects.

It’s had a positive effect on team morale and satisfaction, and resulted in improved product quality and provided useful improvements to the team and our users.

More

HelloSign’s 2016 API Improvements

HelloSign-2016-API-Improvements_contrast

On every wall of our HelloSign office, there hangs a list of our nine core company values. These include things like extreme ownership, transparency, and making our users awesome.

While every value is important to our team, one we hold in particularly high esteem is “constant improvement.” Over the last 6 months we’ve taken constant improvement to heart as we made our HelloSign API more empathetic to developers and more customizable for the companies who wish to embed the eSignature experience into their app or website.

The result has been a suite of new updates for API users, present and future. Check them out below!

More