Authentication

To access the Peach API, you need to include your API key in the Authorization header of each request. The API key ensures secure and authenticated access to the resources provided by the API. This section provides details on how to include the API key in your requests.

Obtaining an API Key

To obtain an API key, please follow these steps:

  1. Navigate to the Developer section in your account settings https://www.peach-in.com/portal/developer-tools

  2. Generate a new API key by clicking the "Add API Key" button.

  3. Make sure to securely store your API key. Treat it as a secret as it grants access to your Peach account and data.

Including the API Key

To include your API key in the Authorization header, follow these steps:

  1. Retrieve your API key from your account settings on the Peach developer portal.

  2. Add the following header to each API request: Authorization: Bearer YOUR_API_KEY

Replace YOUR_API_KEY with your actual API key.

Example

Here's an example of including the API key in a cURL request:

curl -X GET \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.peach-in.com/v4/endpoint

Replace YOUR_API_KEY with your actual API key, and /endpoint with the desired API endpoint you want to access.

PreviousStripe integrationNextCampaigns

Last updated