Skip toΒ content

Start Here: SDKs and a Self Service Platform for your API

12 mins

What is Speakeasy? Why should I use it ? It's simple! Give your API users a best in class developer experience. Self-service every aspect of integration from getting an API key, querying request logs to idiomatic client sdks. Spend less time building table stakes dev ex and more time building your business. Reduce time spent by your dev team on support and and grow your API user community. Interested in learning more ? Come chat with us - on Slack: https://join.slack.com/t/speakeasy-dev/shared_invite/zt-1df0lalk5-HCAlpcQiqPw8vGukQWhexw - book time via Calendly: https://calendly.com/sagar-speakeasy/30min

View Comments and Reply

Transcript

Show Transcript

Everyone. My name's saga, I'm the CEO and co-founder of speakeasy. Uh, speakeasy is an API platform that helps you make your APIs truly self-service.

This means you can onboard users in minutes instead of weeks or months, uh, and also reduce the time spent on support and dealing with the API integration issues.

Um, so, uh, the way we do that is speakeasy has two parts, uh, in the product today. The first part is a set of embeds that power, a dynamic, uh, developer portal experience or embed dial into existing documentation site.

And on the other hand, we also provide client SDKs for your API consumers to use your API in an idiomatic, uh, way and have a great developer experience.

So, um, how does this work? Well, uh, the way you start using speakeasy is we provide a set of, uh, really simple drop in middleware, uh, that allow you to, um, start capturing API requests and response data, uh, sending it to our platform, either hosted or self hosted and use that to start powering a, um, developer portal experience.

So today, uh, I'm gonna be using, uh, go SDK for go API. Uh, so these are public available on our GitHub and it's as a simple global middleware that takes in just a few parameters and starts actually capturing that, uh, API response and request data to power that experience.

So let's head over to a platform. Um, I mean, I've just cleared a new workspace on speakeasy. That's how we group users together.

Um, I'll go ahead and say, add API. Uh, if you have an open API schema, uh, definitely upload it. If you don't, that's fine.

We'll detect it from, or we actually generate it from the traffic that we collect. So I'll go ahead and, uh, upload a spec, um, give the users API name, set a version, and then say generate API key.

I've already set up part of my service. So I'm just gonna grab this snippet, um, and head over to my ID here.

I'm gonna configure, uh, speakeasy as a global middleware, uh, passing a API, I key, um, user ID and a version.

And as we mentioned, uh, you probably want to pass this in as environment variables or, or another secure way now.

Um, what you have to do is now is just simply build and deploy your server. Um, and we'll head over to a request base to start seeing that data come through.

Um, I'm going to use, um, a different workspace, uh, actually one called speakeasy self, which is all the data that speakeasy captures on its own usage.

Uh, this will be more interesting cause there's a lot more data coming through here. Um, so once you go into a workspace, you have your API dashboard that shows You a set of, uh, all the APIs that you have listed.

Uh, we're gonna pick one called registry. You see all the endpoints, um, for each of these endpoints, we have, um, the endpoint path, the method, and some other statistics on usage.

Um, just a couple of quality of life things. You can actually generate a spec from the traffic that is receiving in real time, uh, and download that spec to, and this can help you maintain your API, uh, documentation or any other organizational workflows you have around your open API spec.

Um, we'll click into this API and we'll see that, uh, you can look at all of the different API requests, um, that are coming in, uh, look at all of the content of the request and the response.

Um, and then also, um, really nice things you can actually replay any request that you have. So this is all for your development team to really easily debug, uh, and understand how the API has been used.

Um, but you may wanna surface this information directly to your end user. Uh, so to help you do that, we offer a set of reactive bits, um, and we have clear embeds today, an overview or request via our usage dashboard.

Uh, these help you surface all data, you just saw directly in a developer portal or any other customer facing dashboard.

Um, so your user can, um, self-service looking at logs and understanding how they are using your API. So to do that, we take these in embeds, um, and there's a couple different things in beds.

Let you do. Um, you can create, uh, a filter with your embed that allows you to segment the data specifically for one user.

Who's looking at your development portal. So in this case, we gonna segment the data by a customer ID. Um, so I'll go back to my ID and actually show you a, an app here that we have put together.

Um, we are using a speakeasy embed to power, this experience and the embed, as we mentioned, uh, just takes in a filter, um, to like get access token, which is how we, uh, authorize, um, a specific view on the data that we collect.

Um, and then we just, uh, are able to configure in, in for this demo a to request component, which is, um, just a request viewer, which allows user to look at API request.

So now that that's done, um, I'll go back here and, um, show you the app that's running. Um, and so here we have an embedded request viewer, um, with, uh, the same functionality that your internal developers can use, but now in embedded form.

So it can be in your own UX. Um, so it's a quick overview of how to use speakeasy to, um, supercharge develop portal experience, uh, and have a completely self-service API integration.

Thank you.

Transcript

More than 21 million people across 200,000 companies choose Loom

My teammates and I love using Loom! It has saved us hundreds of hours by creating informative video tutorials instead of long emails or 1-on-1 trainings with customers.
Erica Goodell

Erica GoodellCustomer Success, Pearson

Loom creates an ongoing visual and audible experience across our business and enables our employees to feel part of a unified culture and company.
Tyson Quick

Tyson QuickCEO, Postclick

My new daily email habit. Begin writing an email. Get to the second paragraph and think 'what a time suck.' Record a Loom instead. Feel like 😎.
Kieran Flanagan

Kieran FlanaganVP of Marketing, HubSpot

Loom amplifies my communication with the team like nothing else has. It's a communication tool that should be in every executive's toolbox.
David Okuinev

David OkuinevCo-CEO, Typeform

My teammates and I love using Loom! It has saved us hundreds of hours by creating informative video tutorials instead of long emails or 1-on-1 trainings with customers.
Erica Goodell

Erica GoodellCustomer Success, Pearson

Loom creates an ongoing visual and audible experience across our business and enables our employees to feel part of a unified culture and company.
Tyson Quick

Tyson QuickCEO, Postclick