Skip to main content

Authorization

Follow this guide to create a new Copper credential that will allow Nexla to authenticate to and exchange data with your Copper account.
copper_api_auth.png

Copper

Prerequisites​

Before creating a Copper credential, you need to obtain an API key and the email address of the user who generated the API token from your Copper account. The API key and email are required to authenticate with the Copper API.

To obtain your API key, you need to have a Copper account with API access enabled. Once you have access to your account, you can generate an API key from your Copper Account under System settings > API Keys. The email address should be the email ID of the user who generated the API token. Copper uses custom headers for authentication: X-PW-AccessToken (API key), X-PW-Application (set to developer_api), and X-PW-UserEmail (email of token generator). These headers are sent with all API requests to the Copper API. For detailed information about API key setup and authentication, refer to the Copper API documentation.

Create a Copper Credential​

  • To create a new Copper credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Copper

CopperCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

  1. Enter your Copper API key in the API Key field. This is the API key you obtained from your Copper Account under System settings > API Keys. The API key is sent in the X-PW-AccessToken header for all API requests to the Copper API.

    Keep your API key secure and do not share it publicly. The API key provides access to your Copper account and should be treated as sensitive information. The API key is sent in the X-PW-AccessToken header for all API requests to the Copper API. For detailed information about obtaining and managing API keys, see the Copper API documentation.

  2. Enter the email address of the user who generated the API token in the Email of Token Generator field. This is the email ID of the user who generated the API token. The email is sent in the X-PW-UserEmail header for all API requests to the Copper API.

    The email address must match the email of the user who generated the API token. The email is sent in the X-PW-UserEmail header for all API requests to the Copper API. Copper also requires the X-PW-Application header to be set to developer_api, which is automatically configured by Nexla. For detailed information about authentication requirements, see the Copper API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.