Skip to main content

​
Overview

API keys are the credentials that allow external software to communicate securely with your ECRYPT account. Any time a third-party application or custom integration needs to send payment requests, retrieve transaction data, or interact with your account programmatically, it authenticates using an API key you generate here. Navigate to Settings → Developer Tools → API/Security Keys to manage your keys.

​
When You Need an API Key

You need an API key whenever you are connecting ECRYPT to another system. Common examples include:
  • E-commerce platforms such as WooCommerce, Magento, or other shopping cart software that need to process payments through ECRYPT
  • Custom-built integrations where your development team is building a direct connection to the ECRYPT API
  • Third-party tools that pull transaction or reporting data from your account
You can create as many API keys as you need. A good practice is to create a separate key for each integration or application — this way, if one key ever needs to be revoked, the rest of your integrations are unaffected.

​
Key Types

ECRYPT offers three types of API keys, each with a different level of access:
Key TypeWhat It Does
Public KeyUsed on the client side (e.g., in a checkout form or front-end application) to initiate payment requests. Safe to expose in browser-facing code.
Private KeyUsed on the server side for sensitive operations. Should never be exposed in client-side code or shared publicly.
Reporting KeyProvides read-only access to transaction and reporting data. Use this when an integration only needs to pull reports without the ability to process payments.

​
Creating a Key

  1. Navigate to Settings → Developer Tools → API/Security Keys
  2. Enter a Description to identify what the key is for (e.g., “WooCommerce Production” or “Custom Checkout”)
  3. Select the Key Type — Private Key, Reporting Key, or Public Key
  4. Click Generate New Key
The key appears in the Key’s Table below. Use the copy icon next to any key to copy it to your clipboard. To remove a key, click Delete next to it.

​
Custom Integrations

If you are building a custom integration using the ECRYPT API, visit the Developer Guides Quickstart for full documentation on getting started, authentication, environments, and available endpoints.