Skip to main content

Obtaining Your API Key

Prerequisites​

Before using the Public API, make sure the following conditions are met:

  1. You are logged into your account.
  2. Your account is on the retail_full or fnb_full plan.
  3. Your user role is Owner or Administrator.

Note: The Public API section is only available under these plans and roles. If your plan or role does not match, the section will not be displayed.

Step-by-Step Instructions​

Follow these steps to obtain your first API Key.

  1. Sign in to your Fortis POS Platform at https://my.fortis.world/auth/login
  2. Go to Settings in your account.
  3. Find and select the Public API section. If you are visiting for the first time, the API keys list will be empty and you will be prompted to create a new key.
  4. Click the option to create a new API key.
  5. The key will be generated in the following format: fk_live_<64 hexadecimal characters>
  6. Save this key securely. You will need it for the next steps.
  7. Use the obtained API Key to get a JWT token by following the API authentication guide.

Managing Existing API Keys​

In the Public API section, you may also:

  • View all created API keys
  • Delete an API key — this will immediately invalidate all tokens associated with that key