Developer API

Hey there! In this guide, we'll walk through how to use the Xano Developer API Key to access and consume the open API documentation (also known as Swagger documentation) for your Xano workspaces and API groups. Let's get started!

Step 1: Generate Your Developer API Key

First, you'll need to generate your Developer API Key. Here's how:

1. Log in to your Xano account and navigate to the Account page by clicking on your name in the top-right corner and selecting "Account".
2. On the Account page, you'll see a "Developer Access" section on the right-hand side. Click "Generate API Key".
3. A pop-up window will appear with your unique Developer API Key. Make sure to copy and store this key in a safe place, as it won't be shown again once you leave this page.

If you happen to lose your Developer API Key, you can always come back to this page, revoke the current key, and generate a new one.

Step 2: Access the Swagger Documentation

With your Developer API Key in hand, you can now access the Swagger documentation for your Xano workspaces and API groups. Here's how:

1. Visit app.xano.com/api/developer in your web browser.
2. Click the "Authorize" button and paste your Developer API Key into the pop-up window. Then, click "Authorize" again.
3. You're now at the Xano master instance level. Click the "Execute" button next to the /instances endpoint to retrieve a list of all the instances you have access to.
4. From the response, copy the tokenUrl for the instance you want to explore.
5. Open a new tab or window and paste the tokenUrl into the address bar. This will give you an authToken and a link to the Swagger documentation for that specific instance.
6. Copy the authToken from the response.
7. Open the Swagger documentation link in a new tab or window.
8. Click the "Authorize" button and paste the authToken into the pop-up window. Then, click "Authorize" again.

You're now authenticated and can explore the Swagger documentation for your Xano workspace and API groups within that instance!

Step 3: Explore and Consume API Documentation

With the Swagger documentation open and authenticated, you can now explore and consume the API documentation for your Xano workspace and API groups. Here are a few things you can do:

1. Click the "Try it out" button next to any endpoint to execute it and see the response.
2. To view the Swagger spec (API documentation) for a specific API group, click the group name and then copy the "Swagger Spec" link.
3. Paste the "Swagger Spec" link into a new tab or window, and you'll see the API documentation in YAML format.
4. If you prefer JSON format, append ?type=json to the end of the "Swagger Spec" URL before navigating to it.

That's it! You now know how to use the Xano Developer API Key to access and consume the open API documentation for your Xano workspaces and API groups. This opens up a world of possibilities for integrating with your Xano applications, automating processes, and more.

Happy coding (or no-coding)!