API

Build / API keys

API keys

Every request sends a secret key in the Authorization header. The key's prefix shows which environment it belongs to.

Sending the key

Authorization: Bearer vk_live_8d1Kx...
PrefixHostMoney
vk_test_https://sandbox.vukia.appSimulated
vk_live_https://api.vukia.appReal

A key only works on its own host. A test key sent to production, or a live key sent to the sandbox, is rejected with 401 wrong_environment. The message tells you which host to use. Keys are 40 characters long and contain only letters, digits, _ and -.

Keeping keys safe

How production keys are delivered

We never send a live key in an email. When your production account is approved:

  1. We email your technical contact a one-time link to https://api.vukia.app/claim/…. The link expires after 72 hours.
  2. Opening the link does not reveal the key. Email security scanners often open links automatically. The page waits until a person presses Reveal key.
  3. The key is shown once. Copy it straight into your secret store. After that, the link stops working and the key cannot be retrieved.

If the link expires, or the key was not copied, email [email protected] from your registered contact address and we will send a new link.

Replacing a key

Ask for a replacement if a key may have leaked, if someone who had it leaves, or as routine practice. Email [email protected] from your registered contact address.

The old key stops at once

Each account has one live key. The old key stops working as soon as we create the new link, not when you open it. Agree a time with us, have your deployment ready, and claim the new key straight away. Orders already created are not affected. They keep settling and their webhooks are still delivered.

A sandbox key cannot be replaced. Create a new sandbox account from the quickstart instead.

Authentication errors

StatusCodeMeaning
401missing_api_keyNo Authorization: Bearer … header was sent.
401wrong_environmentA test key was sent to production, or a live key to the sandbox.
401invalid_api_keyThe key does not exist or has been replaced.
403account_disabledThe account has been suspended. Email [email protected].