Introduction

In this section, we'll explain how to use your API key to authenticate requests to our service. The API key is a unique identifier that you should include in all API requests to gain access to our resources.

Your API key should be kept confidential and only used by those authorized to access your account. Do not expose your API key in publicly accessible areas such GitHub, client-side code, and so forth.

Using the API Key

You will need to include your API key in the header of each request. The header key to use is x-api-key. Below, you'll find examples of how to include your API key in both GET and POST requests.

curl -X GET "https://api.connect.xleadfunnel.com/api-endpoint"
-H "x-api-key: YOUR_API_KEY"

curl -X POST "https://api.connect.xleadfunnel.com/api-endpoint"
-H "Content-Type: application/json"
-H "x-api-key: YOUR_API_KEY"
-d '{"param1": "value1", "param2": "value2"}'

In the examples provided above, we use /api-endpoint as a placeholder for the actual API endpoint you will be interacting with.

📌

When implementing these examples in your own applications, you should replace /api-endpoint with the specific endpoint path relevant to the action you want to perform or the resource you want to access.

For instance, our API might have various endpoints like:
/v1/sms for conducting SMS communications.
/v1/mms for conducting MMS communications.
/v1/edm for conducting eDM communications.

API Key Integration

Introduction#

Using the API Key#

Introduction

Using the API Key