Install and Set up StepZen

How to sign up for a StepZen account, install the CLI, and use your keys

While StepZen's service runs in the cloud, we've developed tools to help you quickly build and deploy your StepZen API. Let's walk through getting set up.

Create an Account

Sign up for a free account.

Your Admin Key and API Key

When you get your account, log in to StepZen and visit your My Account page, where you can find your account name, and two keys you need for API authentication:

  • Admin Key: Required to modify your API and its configuration. It is used to upload, modify, and deploy your StepZen APIs.
  • API Key: Grants access to consume/query your endpoint. This is needed for any third-party API testing tools or any application that will consume your API.

Install StepZen

The StepZen command line interface (CLI) allows you to set up and manage StepZen using commands in your command-line shell.

Invoke the following command to install the StepZen CLI:

npm install -g stepzen

Note: The StepZen CLI supports OSX and Linux. Windows support requires the use of WSL2 on Windows 10. For instructions on how to install WSL2, see Microsoft's documentation.

Log in to StepZen via the CLI

Once the CLI is installed, you'll need to connect it to your account. Initiate the login using the following command:

stepzen login

You'll see a series of command prompts asking for your StepZen account name and admin key.

What is your account name?: {ACCOUNT}
What is your admin key?: {ADMINKEY}

The command prompt above pre-populates your account name and admin key (if you are logged in and viewing the docs); but you can always find them on your My Account page.

If you run into an error similar to the following, check that you are copying your login details correctly.

Error: We are unable to verify your account details. Could you please check them?

For more details about the StepZen CLI, see StepZen CLI.

You can now proceed to Hello World: Build Your First API.

This site uses cookies: By using this website, you consent to our use of cookies in accordance with our Website Terms of Use and Cookie Policy.