Day 1 - Introducing the ZAPI Management API
We ❤️ API Keys at Zuplo. Of course, We love all the ways of authentication calls to an API from JWTs to Basic Auth — but we have a special soft-spot for API keys.
We have natively supported API keys, helping our customers offer this important authentication option since the beginning. However, we've made many changes to the service since then and have completely re-built our API key management API which we're announcing today.
Why API keys?#
So why API keys? Why not use a standard like OAuth and JWT tokens. One thing to observe is that the best API companies in the world use API Keys to secure their API - stripe, github, and twilio are a few prominent examples.
One of the key reasons to choose API keys is create the best possible experience
for your API consumers. API Keys are just easier to work with, easier to cURL,
easier to use with
But are they secure? Yes, as long as you follow some best practices. We outlined a detailed blog post and YouTube video on these best practices for your enjoyment:
Secret scanning included at all tiers#
One of the most important best practices is to support secret scanning, to catch accidental check ins of API keys to public repos (and private repos that opt in). We partnered with GitHub to announce this partnership:
- Read the post: Zuplo is now a GitHub secret scanning partner
The bar for API experience has raised#
Stripe still probably holds the crown of gold-standard API experience. Our goal at Zuplo is to help every business offer a gold-standard experience to their API consumers. Engineers are craftspeople, and want to put things out into the world that they are proud of and other developers would respect. It's a matter of pride.
Over the years since Stripe launched, the bar for a great developer experience around APIs has raised, and the following items are must haves:
- Support API keys for org-org authentication
- Quality, beautiful API specification documentation
- Self-serve API key management and key rolling
- Clear and consistent error messages, using standards like Problem Details
- Developer facing analytics showing history of a consumers API calls
No surprise that Zuplo gives you all of these (yes, even developer-facing analytics... stay tuned for more updates this week).
Use our Developer Portal or BYO (bring your own)#
We want to help businesses get a Stripe-quality API experience with minimum effort, so we provide a full Developer Portal with self-serve key management. However, some people want more control and want to integrate things like API key management into their own developer console. Our customer Common Paper (see interview) did exactly this.
To do this, you need to use our API Key management API which is part of ZAPI. The Zuplo API. Check out our reference here:
The API is easy to use. We aimed to give you the right building blocks to make the API key experience YOU want for your customers.
We made a video to explain how the API works and how you can integrate API key management into your own developer console. Here's the video guide:
Tomorrow, we'll have a new announcement that will make this whole process even easier.
This is Day 1 of API Key week#
Come back to check out new content and announcements each day!