- Render input fields to securely collect and encrypt card details.
- Detect the card type from the number the shopper entered in the payment form.
- Do server-side barcode or QR code rendering for payment methods such as Swish or Boleto Bancário.
The client key is not used when making requests to our APIs. For API requests, you need to get an API key.
With the client key, you have:
- A single key for all your allowed origins in an environment.
- Flexibility to add and remove origins without having to generate a new client key.
- A human-readable prefix, test or live, so you can easily tell which environment a client key is linked to.
Availability and compatibility
The client key is available for the following:
|Web Drop-in and Components||Available for 3.10.1 and later. Previous versions require origin keys for client-side authentication.
Starting 4.0.0 the client key is the only way to do client-side authentication.
|iOS Drop-in and Components||3.7.0 and later.
Previous versions require client encryption public keys.
How it works
The client key is a public key that uniquely identifies an API credential. Each API credential has a list of allowed origins, or domains from which we expect to get your requests. We make sure data cannot be accessed by unknown parties by using Cross-Origin Resource Sharing.
A client key is linked to an API credential and its environment. The client key has two parts:
- A 32-character string encoding the API credential
- A human-readable environment prefix
For example, test_870be2854add4f56b86778353010f36c is a client key for the test environment. When you switch to your live environment, you need to generate a client key in your live Customer Area. The client key for your live environment will start with live_.
Allowed origins are domains from which we expect to get your client-side requests.
The allowed origins:
- Can include a wildcard, for example
- Can have
httpin the test environment, for example
- Must have
httpsin the live environment.
Allowed origins are linked to the API credential, so you can add or remove allowed origins without needing to generate a new client key.
Get your client key
- Log in to your Customer Area.
- Go to Account > API credentials, and select the API credential for your integration, for example ws@Company.[YourCompanyAccount].
- Add your domains under Allowed origins. These are the domains from which you will be sending your client-side requests.
- Under Authentication, select Generate New Client Key.
- Select Save.
If you generated a new client key, the old one expires after 24 hours.
You now have a client key for your ws@Company.[YourCompanyAccount] API credential, which is linked to your test environment. To get a client key for your live environment, follow the same steps in your live Customer Area.
Manage allowed origins
You can add or remove allowed origins for an API credential without needing to generate a new client key.
- Log in to your Customer Area .
- Go to Account > API credentials, and select the API credential for your Web Drop-in or Web Components integration, for example ws@Company.[YourCompanyAccount].
- Under Allowed origins you can add or remove domains. These are the domains from which you will be sending your client-side requests.
- Select Save at the bottom of the page. It takes a few seconds for new allowed origins to become available for your application.