Getting Started with StepZen

How to get set up and begin deploying your first GraphQL API to StepZen

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.

Install the StepZen CLI

The StepZen command line interface (CLI) allows you to set up and manage StepZen using commands in your command-line shell. It can be installed globally via npm.

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, check Microsoft's documentation.

Once the CLI is installed, you'll need to log it into your account. Log in to your account. You'll need the name of your StepZen Account and your admin key. We've included both below, but you can always find them on your my account page. After you run stepzen login you'll be asked for these details as shown below.

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

Upon login, you'll get a response:

You have successfully logged in.

If you run into

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

then double-check to make sure you are copying your login details correctly.

For a detailed walkthrough of the StepZen CLI, go here.

What's the Difference Between the Admin Key and the API Key

The my account page provides two keys:

  • The Admin key is required to modify your API and its configuration. The StepZen CLI requires this as it will be used to upload, modify and deploy your StepZen APIs.
  • API Key grants access and consume/query your endpoint. This will be needed in any third-party API testing tools or any application that wil be consuming your 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.