Skip to main content

Generate API Key

You will need an API key to create and scan passes with the ethpass API.

First, log into your account at ethpass.xyz.

Navigate to the Developer Dashboard and open up your project.

In the settings tab, click Generate API Key, and you are all set!

Settings tab graphic

Using Your API Key​

To make requests with your API key, include it in the headers of your requests.

const payload = {...}

const response = await fetch("https://api.ethpass.xyz/api/v0/passes", {
  method: "POST",
  body: JSON.stringify(payload),
  headers: new Headers({
      "content-type": "application/json",
      "X-API-KEY": "YOUR_SECRET_API_KEY"
  }),
});

Once you have your API key, it’s as simple as using the ethpass API to allow users to create and scan passes.

Resetting Your Key​

We strongly recommend keeping the key private, and not committing it to any repositories. If you ever need to reset the key, you can do so in the dashboard, under the API Keys section of your project.

Reset key graphic