Authentication and API Keys

The Pace Software API uses API keys for authentication, allowing you to securely access and manage your account data. This section provides an overview of how to obtain, use, and manage your API keys for authenticating with the Pace Software API.

Obtaining an API Key

To obtain an API key, follow these steps:

Sign in to the Pace Software web portal with your account credentials.
Navigate to the Client Profile settings.
Locate the API Key section and click on the "Generate API Key" button.
Your new API key will be displayed. Copy and store it in a secure location.

Obtain an API Key

Be Careful with Your API Key

Treat your API key as a sensitive credential. Do not share it with unauthorized individuals or expose it in public repositories, logs, or client-side code.

Using Your API Key

To authenticate with the Pace Software API, include your API key in the x-api-key header of each API request:

Copy

Copied

GET /your_endpoint
Host: api-portal.pacesoft.net
x-api-key: YOUR_API_KEY

Replace YOUR_API_KEY with your actual API key obtained from the Client Profile settings in the web portal.

Managing API Keys

You can manage your API keys within the Client Profile settings of the Pace Software web portal. This includes generating new keys, revoking existing keys, and viewing the keys' creation timestamps.

attention

When you generate a new API key, the previous key becomes invalid. Make sure to update your applications and integrations with the new API key to avoid disruptions in service.