Skip to main content

​
Types of Credentials

There are two types of credentials: Sandbox and Production credentials. The sandbox credentials are for use in the sandbox environment during testing, while the production credentials are set up when going live.

​
Structure of Credentials

The API credentials include:
  • Client ID (client_id): Public identifier for your integration.
  • Integration Title (sender): The name assigned to your integration.
  • Secret Key (senderKey): The private key used strictly on your backend server to generate the cryptographic signature for each API request.

​
Getting Credentials

Please follow these steps to set up your API credentials:
1

Creating a new integration

  1. In the developer portal, on the sidebar menu under “Workspace”, select the option “Integrations” where you will manage integrations and API keys.
  2. Begin by creating your first integration by clicking the “Create Integration” button. We recommend creating one integration for each of the projects or brands you are connecting.
  3. You need to create separate integrations for both sandbox and live accounts in their respective environments.
2

Generating API Credentials

  1. Within the Integration settings, generate the required credentials for the integration.
  2. These credentials consist of a Client ID, Integration Name, and Secret Key. Make sure to save these credentials securely. Treat your Secret Key like a password. Never expose it in frontend code, client apps, or public logs.
  3. This key serves as your authentication mechanism when signing API requests.
3

Using the credentials

You are now ready to integrate the Niobi Payments API into your application. Proceed to the Authentication Basics guide to learn how to sign your first request.

​
Next Step

API Authentication Basics

Learn how to use your Client ID and Secret Key to cryptographically sign API requests.