Skip to main content

How do I get an API key?

Create a project in your dashboard to get an API Key and API Secret.

You get an API key by creating a project in your Wiro dashboard. Each project has its own API Key and API Secret.

  1. Sign in and go to New Project.

  2. Choose an Auth Method (see below).

  3. Click Create Project.

  4. Copy your API Key and API Secret and store them somewhere safe.

To see them later, open the Projects page and click the eye icon next to API Key or API Secret. Confirm it's you with your password or a 4-digit code we e-mail you, and they stay visible for 10 minutes. On a team project, only team admins and the organization owner can see the API Secret again, so a member who creates a team project should copy it right away.

Which auth method should I choose?

  • Signature Based (Recommended): each request sends the x-api-key, x-signature and x-nonce headers. The API Secret never travels with a request, but whatever signs requests has to hold it, so sign them on your own server and keep the secret out of browser and mobile app code.

  • API Key Only (Simple): just send the x-api-key header. It's simpler, and fine if you call the API from your own backend.

You can change a project's auth method later in the project's settings. The API key and secret stay the same, but your requests must then use the new method.

Good to know

  • IP Whitelist is optional. Leave it empty to accept requests from any IP address. If you change it later, a new API Secret is generated, so update your integration.

  • Keep your API Secret private, and never put it in public code or repositories.

  • If a key or secret leaks: there's no button to make a new key for an existing project, and changing the IP Whitelist gives you a new API Secret but keeps the same API Key. Create a new project, switch your integration to its key and secret, then choose Remove in the old project's menu on Projects. The old key stops working as soon as the project is removed, and this can't be undone. Tasks you ran with it stay in your history. Step by step: How do I replace or revoke my API key?

Next steps: see Authentication for how to sign requests, and the API documentation for everything else.

Did this answer your question?

Related Articles