# Overview

Welcome to the **Influencer Hero API** documentation! This API provides powerful endpoints and webhooks to help you manage influencer collaborations, track affiliate performance, and automate key tasks on the Influencer Hero platform.

In this guide, you'll learn how to:

- Set up authentication and make requests to our API.
- Integrate with key endpoints for searching, CRM, and account management.
- Configure webhooks to receive real-time updates on account events.


## Table of Contents

1. [Getting Started](#getting-started)
2. [API Base URL](#api-base-url)
3. [Authentication](#authentication)
4. [Endpoints Overview](#endpoints-overview)
  - [Search](#search)
  - [Affiliate Tracking](#affiliate-tracking)
  - [CRM](#crm)
  - [Account](#account)
5. [Webhooks](#webhooks)
6. [Error Handling](#error-handling)
7. [Changelog](#changelog)
8. [Support](#support)


## Getting Started

The Influencer Hero platform is a SaaS solution that allows brands to discover influencers, manage collaborations, track performance, and more. The Influencer Hero API extends these capabilities, enabling you to integrate these functions into your own application or workflow.

This documentation covers our **RESTful** endpoints and **webhooks**. All requests and responses are in JSON format.

Before you begin, you will need:

- An **Influencer Hero** account.
- Appropriate **API key**


**Note**: If you already have API access, you can find your API key and webhook signing secret under [https://app.influencer-hero.com/api_integration](https://app.influencer-hero.com/api_integration). If you do not have API access, please contact your account administrator or Influencer Hero support to request access.

## API Base URL

All requests should be sent to our production base URL:

**https://api.influencer-hero.com**

Any request to other subdomains or paths might not be supported or may be reserved for development and testing purposes.

## Authentication

Influencer Hero’s API uses **API key-based** authentication. You should provide an X-API-KEY header with your API key.

### Example Request


```bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: YOUR_API_KEY_HERE" \
  -d '{"influencer_list": ["test@example.com"], "brand_id": 1001}' \
  https://api.influencer-hero.com/v1/search/identify_influencers
```

# Endpoints Overview

Below is a high-level overview of the available endpoint groups. For full details on request and response structures (including example payloads), see each endpoint’s reference in the API Reference.

## Affiliate Tracking

Endpoints to track clicks, referrals, and sales for influencer collaborations:

**POST** `/v1/crm/increase_influencer_clicks`
Increases the number of tracked clicks on a deal page.

**POST** `/v1/crm/new_influencer_referral`
Records a new order/referral to an influencer’s performance.

## CRM

Endpoints for creating and retrieving deals, and finding influencers:

**GET** `/v1/crm/get_deal_details`
Retrieve details of a specific deal.

**POST** `/v1/crm/create_deal`
Create (import) a new influencer deal into your CRM.

**POST** `/v1/search/identify_influencers`
Identify influencers based on contact details.

## Account

Endpoints for account-based operations such as brands, dealflows, and webhook configuration:

**GET** `/v1/account/search_dealflows`
Retrieve all dealflows in the user’s account.

**GET** `/v1/account/search_brands`
Retrieve or search for brands in the user’s account.

**POST** `/v1/account/create_webhook`
Create new webhooks for product, discount code updates, influencer replies, etc.

**DELETE** `/v1/account/delete_webhook`
Delete a previously configured webhook.

## Webhooks

Influencer Hero webhooks allow you to receive real-time notifications whenever specific events occur in your account. Our webhooks are secured via HMAC-SHA256 signatures, ensuring that only legitimate requests from Influencer Hero reach your servers.

### How It Works

1. You configure a webhook endpoint via `POST /v1/account/create_webhook` (or via the UI at [https://app.influencer-hero.com/api_integration](https://app.influencer-hero.com/api_integration))
2. Influencer Hero sends a `POST` request to your webhook URL whenever the configured event occurs.
3. Verify the request using the headers:
  - `X-InfluencerHero-Timestamp` (the UNIX timestamp when the request was sent)
  - `X-InfluencerHero-Signature` (the HMAC-SHA256 signature computed using your secret and the request body)
4. Return a `2xx` status code to acknowledge receipt of the event.


### Common Webhooks

- `new_payout_request`
Fired when your user creates a payout request.
- `new_max_bid`
Fired when a new Max Bid is requested for a deal.
- `update_discount_code`
Fired when a discount code is updated.
- `update_commission`
Fired when a commission percentage is updated.
- `update_custom_link`
Fired when a custom affiliate link is updated.
- `product_sent`
Fired when your user sends a product to an influencer.
- `new_email_sent`
Fired when a new email is sent to an influencer.
- `new_influencer_post`
Fired when an influencer publishes a new social media post tied to your brand.
- `new_influencer_reply`
Fired when an influencer replies to an email.


For full JSON payload details and validation schemas, see the Webhooks section.

## Error Handling

The Influencer Hero API uses conventional HTTP response codes to indicate success or failure. In general:

- `2xx` responses indicate success.
- `4xx` responses indicate a request error (e.g., missing or invalid parameters).
- `5xx` responses indicate server-side errors.


Each endpoint outlines the possible HTTP status codes and the corresponding JSON responses. Example:


```json
{
  "message": "Brand not found"
}
```

Always check the message or error field in the response to understand the reason for the failure.

## Support

If you have questions, encounter issues, or need further assistance:

- Check our FAQ
- Send an email to [support@influencer-hero.com](mailto:support@influencer-hero.com)
- Or reach out via our in-app chat for direct help.


We’re here to ensure your integration with Influencer Hero is seamless and successful.
Thank you for using the Influencer Hero API!