DonationAlerts API

https://www.donationalerts.com/apidoc
Admin
The DonationAlerts public API provides a RESTful interface for developers to interact with...
Tokens:26,586
Snippets:122
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Update Merchandise - response example

Source: https://www.donationalerts.com/apidoc

Example JSON response from the update merchandise endpoint. Shows the updated merchandise object with merchant info, title locales, flags, currency, prices, URLs, and end_at.

```json
{
    "data": {
        "id": 3,
        "merchant": {
            "identifier": "MARKET_GAMES_MAIL_RU",
            "name": "Market games@mail.ru"
        },
        "identifier": "8082",
        "title": {
            "en_US": "Credit case",
            "ru_RU": "Кредитный кейс"
        },
        "is_active": 1,
        "is_percentage": 1,
        "currency": "USD",
        "price_user": 30,
        "price_service": 15,
        "url": "https://market.games.mail.ru/game/1?product_id=8082&user_id={user_id}",
        "img_url": "https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png",
        "end_at": null
    }
}
```

--------------------------------

### Create Merchandise - curl Request

Source: https://www.donationalerts.com/apidoc

Example curl command to create a new merchandise via the POST /api/v1/merchandise endpoint. It includes required parameters such as merchant_identifier, merchandise_identifier, title, currency, price_user, price_service, and signature. The example uses form data and includes optional parameters like is_active, is_percentage, url, and img_url.

```bash
curl --location --request POST 'https://www.donationalerts.com/api/v1/merchandise' \
--header 'Authorization: Bearer <token>' \
--form 'merchant_identifier=MARKET_GAMES_MAIL_RU' \
--form 'merchandise_identifier=8082' \
--form 'title[en_US]=Credit case' \
--form 'title[ru_RU]=Кредитный кейс' \
--form 'is_active=1' \
--form 'is_percentage=1' \
--form 'currency=USD' \
--form 'price_user=30' \
--form 'price_service=15' \
--form 'url=https://market.games.mail.ru/game/1?product_id=8082&user_id={user_id}' \
--form 'img_url=https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png' \
--form 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'
```

--------------------------------

### GET request for page 2 of donations

Source: https://www.donationalerts.com/apidoc

Example curl command to request the second page of donations using the page query parameter.

```bash
curl \
    -X GET https://www.donationalerts.com/api/v1/alerts/donations?page=2 \
    -H "Authorization: Bearer <token>"
```

--------------------------------

### GET request to fetch donations

Source: https://www.donationalerts.com/apidoc

Example curl command to retrieve donations from the DonationAlerts API. Requires an Authorization Bearer token.

```bash
curl \
    -X GET https://www.donationalerts.com/api/v1/alerts/donations \
    -H "Authorization: Bearer <token>"
```

--------------------------------

### User Profile Response Body

Source: https://www.donationalerts.com/apidoc

Example JSON response body for the user profile endpoint.

```json
{
    "data": {
        "id": 3,
        "code": "tris_the_jam_master",
        "name": "Tris_the_Jam_Master",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/tris_the_jam_master-profile_image-c084755ce36ab72b-300x300.jpeg",
        "email": "sergey@donationalerts.com",
        "socket_connection_token": "yeJ0eXTYOiJKV1RiLCKhbGciOiJIU4.iJIUfeyJzdeyJzd.GciJIUfiOas_FCvQTYAA8usfsTYYFD"
    }
}
```

--------------------------------

### Get User Profile with curl

Source: https://www.donationalerts.com/apidoc

Sends a GET request to the user profile endpoint. Requires the oauth-user-show scope.

```bash
curl \
    -X GET https://www.donationalerts.com/api/v1/user/oauth \
    -H "Authorization: Bearer <token>"
```

--------------------------------

### JSON response body for access token

Source: https://www.donationalerts.com/apidoc

Example JSON response body from the token endpoint containing token_type, access_token, expires_in, and refresh_token fields. The access_token and refresh_token values are truncated with ellipses in the example.

```json
{
    "token_type": "Bearer",
    "access_token": "...msdisYBVnciOiJSUzI1NiIsImp0aSI6IjQxZDU0ZGQ2O...",
    "expires_in": 631151999,
    "refresh_token": "...173da4e0ff4d48c8cbde7a0071f770624a83259f0a11cd02ec1ce71fe924c4..."
}
```

--------------------------------

### Create Merchandise - HTTP Response

Source: https://www.donationalerts.com/apidoc

Example HTTP response headers for a successful merchandise creation, showing a 201 Created status and JSON content type.

```http
HTTP/1.1 201 Created
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Thu, 15 Nov 2020 08:37:37 GMT
```

--------------------------------

### HTTP response headers and JSON body for donations

Source: https://www.donationalerts.com/apidoc

Example response from the donations endpoint, showing HTTP headers and a JSON body with donation data and pagination metadata.

```http
HTTP/1.1 200 OK
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Date: Sat, 1 Sep 2019 18:42:33 GMT
Content-Language: en_US
```

```json
{
    "data": [
        {
            "id": 30530030,
            "name": "donation",
            "username": "Ivan",
            "message": "Hello!",
            "amount": 500,
            "currency": "RUB",
            "is_shown": 1,
            "created_at": "2019-09-29 09:00:00",
            "shown_at": null
        }
    ],
    "links": {
        "first": "https://www.donationalerts.com/api/v1/alerts/donations?page=1",
        "last": "https://www.donationalerts.com/api/v1/alerts/donations?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://www.donationalerts.com/api/v1/alerts/donations",
        "per_page": 30,
        "to": 1,
        "total": 1
    }
}
```

--------------------------------

### GET /api/v1/user/oauth

Source: https://www.donationalerts.com/apidoc

Obtains user profile information. Requires user authorization with the 'oauth-user-show' scope.

```APIDOC
## GET /api/v1/user/oauth

### Description
Obtains user profile information. Requires user authorization with the `oauth-user-show` scope.

### Method
GET

### Endpoint
https://www.donationalerts.com/api/v1/user/oauth

### Parameters
#### Query String
- **id** (integer) - Required - The unique and unchangeable user identifier
- **code** (string) - Required - The unique user name
- **name** (string) - Required - The unique displayed user name
- **avatar** (string) - Required - The URL to the personalized graphical illustration
- **email** (string) - Required - The email address
- **socket_connection_token** (string) - Required - Centrifugo connection token

### Request Example
```
curl \
    -X GET https://www.donationalerts.com/api/v1/user/oauth \
    -H "Authorization: Bearer <token>"
```

### Response
#### Success Response (200)
- **id** (integer) - The unique and unchangeable user identifier
- **code** (string) - The unique user name
- **name** (string) - The unique displayed user name
- **avatar** (string) - The URL to the personalized graphical illustration
- **email** (string) - The email address
- **socket_connection_token** (string) - Centrifugo connection token

#### Response Example
```
HTTP/1.1 200 OK
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Sat, 28 Sep 2019 11:19:57 GMT
```

```
{
    "data": {
        "id": 3,
        "code": "tris_the_jam_master",
        "name": "Tris_the_Jam_Master",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/tris_the_jam_master-profile_image-c084755ce36ab72b-300x300.jpeg",
        "email": "sergey@donationalerts.com",
        "socket_connection_token": "yeJ0eXTYOiJKV1RiLCKhbGciOiJIU4.iJIUfeyJzdeyJzd.GciJIUfiOas_FCvQTYAA8usfsTYYFD"
    }
}
```
```

--------------------------------

### Get User Data from Promocode - Response Body

Source: https://www.donationalerts.com/apidoc

JSON response body containing the user_id associated with the promocode.

```json
{
    "data": {
        "user_id": 3
    }
}
```

--------------------------------

### Merchandises

Source: https://www.donationalerts.com/apidoc

Endpoints for managing merchandises, including create, update, update or create, and getting user data from promocode.

```APIDOC
## Merchandises

### Description
Endpoints for managing merchandises, including create, update, update or create, and getting user data from promocode.

### Endpoints
- Create Merchandise
- Update Merchandise
- Update or Create Merchandise
- Get User Data from Promocode

```

--------------------------------

### curl POST merchandise_sale with signature

Source: https://www.donationalerts.com/apidoc

Creates a merchandise sale alert. Requires an Authorization Bearer token and a signature. The example uses user_id=3, amount=100, currency=RUB, and includes optional fields like bought_amount, username, and message.

```bash
curl --location --request POST 'https://www.donationalerts.com/api/v1/merchandise_sale' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'user_id=3' \
--data-urlencode 'amount=100' \
--data-urlencode 'currency=RUB' \
--data-urlencode 'merchant_identifier=MARKET_GAMES_MAIL_RU' \
--data-urlencode 'merchandise_identifier=3372' \
--data-urlencode 'external_id=1' \
--data-urlencode 'bought_amount=2' \
--data-urlencode 'username=John' \
--data-urlencode 'message=This is a test message' \
--data-urlencode 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'
```

--------------------------------

### HTTP Response Headers for Custom Alert

Source: https://www.donationalerts.com/apidoc

Example HTTP response headers returned when a custom alert is successfully created. Shows a 201 Created status and JSON content type.

```http
HTTP/1.1 201 Created
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Thu, 24 Sep 2020 12:04:23 GMT
```

--------------------------------

### curl Request to Update or Create Merchandise

Source: https://www.donationalerts.com/apidoc

Example curl command to call the PUT endpoint for updating or creating merchandise, using form fields for title, prices, and signature.

```bash
curl --location --request PUT 'https://www.donationalerts.com/api/v1/merchandise/MARKET_GAMES_MAIL_RU/8082' \
--header 'Authorization: Bearer <token>' \
--form 'title[en_US]=Credit case' \
--form 'title[ru_RU]=Кредитный кейс' \
--form 'is_active=1' \
--form 'is_percentage=1' \
--form 'currency=USD' \
--form 'price_user=30' \
--form 'price_service=15' \
--form 'url=https://market.games.mail.ru/game/1?product_id=8082&user_id={user_id}' \
--form 'img_url=https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png' \
--form 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'
```

--------------------------------

### HTTP Response Headers for Merchandise API

Source: https://www.donationalerts.com/apidoc

Example HTTP response headers returned by the DonationAlerts API, showing server, content type, and caching details.

```http
HTTP/1.1 200 OK
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Thu, 15 Nov 2020 08:37:37 GMT
```

--------------------------------

### GET /api/v1/alerts/donations

Source: https://www.donationalerts.com/apidoc

Obtains array of objects of user donation alerts list. Requires user authorization with the 'oauth-donation-index' scope.

```APIDOC
## GET /api/v1/alerts/donations

### Description
Obtains array of objects of user donation alerts list. Requires user authorization with the `oauth-donation-index` scope.

### Method
GET

### Endpoint
https://www.donationalerts.com/api/v1/alerts/donations

### Parameters
#### Query String
- **id** (integer) - Required - The unique donation alert identifier
- **name** (string) - Required - Type of the alert. Always `donation` in this case
- **username** (string) - Required - The name of the user who sent the donation and the alert
- **message_type** (string) - Required - The message type. The possible values are `text` for a text messages and `audio` for an audio messages
- **message** (string) - Required - The message sent along with the donation and the alert
- **amount** (number) - Required - The donation amount
- **currency** (string) - Required - The currency code (ISO 4217 formatted)
- **is_shown** (integer) - Required - A flag indicating whether the alert was shown in the streamer's widget
- **created_at** (string) - Required - The donation date and time (YYYY-MM-DD HH.MM.SS formatted)
- **shown_at** (string, null) - Required - Date and time indicating when the alert was shown (YYYY-MM-DD HH.MM.SS formatted). Or `null` if the alert is not shown yet

### Request Example
```
curl \
    -X GET https://www.donationalerts.com/api/v1/alerts/donations \
    -H "Authorization: Bearer <token>"
```

### Response
#### Success Response (200)
- **id** (integer) - The unique donation alert identifier
- **name** (string) - Type of the alert. Always `donation` in this case
- **username** (string) - The name of the user who sent the donation and the alert
- **message_type** (string) - The message type. The possible values are `text` for a text messages and `audio` for an audio messages
- **message** (string) - The message sent along with the donation and the alert
- **amount** (number) - The donation amount
- **currency** (string) - The currency code (ISO 4217 formatted)
- **is_shown** (integer) - A flag indicating whether the alert was shown in the streamer's widget
- **created_at** (string) - The donation date and time (YYYY-MM-DD HH.MM.SS formatted)
- **shown_at** (string, null) - Date and time indicating when the alert was shown (YYYY-MM-DD HH.MM.SS formatted). Or `null` if the alert is not shown yet

#### Response Example
```
HTTP/1.1 200 OK
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Sat, 28 Sep 2019 11:19:57 GMT
```

```
{
    "data": [
        {
            "id": 30530030,
            "name": "donation",
            "username": "Ivan",
            "message_type": "text",
            "message": "Hello!",
            "amount": 500,
            "currency": "RUB",
            "is_shown": 1,
            "created_at": "2019-09-29 09:00:00",
            "shown_at": null
        }
    ],
    "links": {
        "first": "https://www.donationalerts.com/api/v1/alerts/donations?page=1",
        "last": "https://www.donationalerts.com/api/v1/alerts/donations?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://www.donationalerts.com/api/v1/alerts/donations",
        "per_page": 30,
        "to": 1,
        "total": 1
    }
}
```
```

--------------------------------

### Get User Data from Promocode - cURL Request

Source: https://www.donationalerts.com/apidoc

cURL command to retrieve user ID from an advertising promocode. Requires a valid promocode and signature, and an Authorization Bearer token.

```bash
curl \
-X GET https://www.donationalerts.com/api/v1/merchandise/user?promocode=test123&signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6 \
-H "Authorization: Bearer <token>"
```

--------------------------------

### Plugins & Libraries

Source: https://www.donationalerts.com/apidoc

Documentation for plugins and libraries, including Unreal Engine 4 plugin usage.

```APIDOC
## Plugins & Libraries

### Description
Documentation for plugins and libraries, including Unreal Engine 4 plugin usage.

### Sections
- Unreal Engine 4 Plugin
  - Usage

```

--------------------------------

### GET /api/v1/merchandise/user

Source: https://www.donationalerts.com/apidoc

Obtains user ID from an advertising promocode. This API is a part of the Merchandise Advertisement API and can be used to get a user ID and then pass it to the Send Sale Alerts API.

```APIDOC
## [GET] /api/v1/merchandise/user

### Description
Obtains user ID from an advertising promocode. This API is a part of the Merchandise Advertisement API. Can be used to get a user ID and then pass it to the Send Sale Alerts API.

### Method
GET

### Endpoint
/api/v1/merchandise/user

### Parameters
#### Query Parameters
- **promocode** (string) - Required - User promocode.
- **signature** (string) - Required - Request signature.

### Request Example
curl \
-X GET https://www.donationalerts.com/api/v1/merchandise/user?promocode=test123&signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6 \
-H "Authorization: Bearer <token>"

### Response
#### Success Response (200)
- **data** (object) - Response data.
- **data.user_id** (integer) - DonationAlerts user ID to which this advertising promocode is referenced.

#### Response Example
{
    "data": {
        "user_id": 3
    }
}
```

--------------------------------

### HTTP 201 Created response headers

Source: https://www.donationalerts.com/apidoc

Response headers returned when the sale alert is successfully created. Includes Content-Type: application/json and Cache-Control: no-cache, private.

```http
HTTP/1.1 201 Created
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Thu, 24 Sep 2020 11:36:14 GMT
```

--------------------------------

### GET /api/v1/alerts/donations

Source: https://www.donationalerts.com/apidoc

Retrieves a list of donation alerts for the authorized user. Supports pagination and filtering by date range.

```APIDOC
## GET /api/v1/alerts/donations

### Description
Retrieves a list of donation alerts for the authorized user.

### Method
GET

### Endpoint
/api/v1/alerts/donations

### Parameters
#### Query Parameters
- **access_token** (string) - Required - OAuth access token for authorization.
- **page** (integer) - Optional - Page number for pagination.
- **limit** (integer) - Optional - Number of items per page (max 100).
- **created_at[from]** (string) - Optional - Start date for filtering (ISO 8601).
- **created_at[to]** (string) - Optional - End date for filtering (ISO 8601).

### Response
#### Success Response (200)
- **data** (array) - List of donation objects.
  - **id** (integer) - Donation ID.
  - **name** (string) - Donor name.
  - **amount** (float) - Donation amount.
  - **currency** (string) - Currency code.
  - **message** (string) - Donation message.
  - **created_at** (string) - Donation creation timestamp.
- **meta** (object) - Pagination metadata.
  - **current_page** (integer) - Current page number.
  - **last_page** (integer) - Last page number.
  - **per_page** (integer) - Items per page.
  - **total** (integer) - Total number of donations.

#### Response Example
{
  "data": [
    {
      "id": 1,
      "name": "Alice",
      "amount": 10.5,
      "currency": "USD",
      "message": "Great stream!",
      "created_at": "2023-01-01T12:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 20,
    "total": 1
  }
}
```

--------------------------------

### Donation Alerts List Response Body

Source: https://www.donationalerts.com/apidoc

Example JSON response body for the donation alerts list endpoint.

```json
{
    "data": [
        {
            "id": 30530030,
            "name": "donation",
            "username": "Ivan",
            "message_type": "text",
            "message": "Hello!",
            "amount": 500,
            "currency": "RUB",
            "is_shown": 1,
            "created_at": "2019-09-29 09:00:00",
            "shown_at": null
        }
    ],
    "links": {
        "first": "https://www.donationalerts.com/api/v1/alerts/donations?page=1",
        "last": "https://www.donationalerts.com/api/v1/alerts/donations?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://www.donationalerts.com/api/v1/alerts/donations",
        "per_page": 30,
        "to": 1,
        "total": 1
    }
}
```

--------------------------------

### GET /api/v1/user/oauth

Source: https://www.donationalerts.com/apidoc

Retrieves the profile information of the currently authorized user. This endpoint requires the OAuth token with the appropriate scope.

```APIDOC
## GET /api/v1/user/oauth

### Description
Retrieves the profile information of the currently authorized user.

### Method
GET

### Endpoint
/api/v1/user/oauth

### Parameters
#### Query Parameters
- **access_token** (string) - Required - OAuth access token for authorization.

### Response
#### Success Response (200)
- **id** (integer) - User ID.
- **code** (string) - Unique user code.
- **name** (string) - Display name.
- **avatar** (string) - URL to the user's avatar.
- **email** (string) - User's email address.
- **language** (string) - User's language code.
- **socket_connection_token** (string) - Token for Centrifugo connection.

#### Response Example
{
  "id": 12345,
  "code": "abc123",
  "name": "John Doe",
  "avatar": "https://example.com/avatar.jpg",
  "email": "john@example.com",
  "language": "en",
  "socket_connection_token": "token123"
}
```

--------------------------------

### HTTP 401 Unauthorized error response

Source: https://www.donationalerts.com/apidoc

Example error response for an unauthenticated request, showing HTTP headers and a JSON error message.

```http
HTTP/1.1 401 Unauthorized
Server: nginx/1.13.5
Content-Type: application/json
```

```json
{
    "message": "Unauthenticated."
}
```

--------------------------------

### Exchange authorization code for access token with curl

Source: https://www.donationalerts.com/apidoc

Use this curl command to POST to https://www.donationalerts.com/oauth/token with the authorization code and client credentials. The request uses application/x-www-form-urlencoded content type and includes grant_type, client_id, client_secret, redirect_uri, and code parameters. Replace the placeholders with actual values.

```bash
curl \
    -X POST https://www.donationalerts.com/oauth/token \
    -H "Content-Type: application/x-www-form-urlencoded" \
    -d "grant_type=authorization_code&client_id=<client_id>
&client_secret=<client_secret>&redirect_uri=<redirect_uri>&code=<code>"
```

--------------------------------

### GET https://www.donationalerts.com/oauth/authorize

Source: https://www.donationalerts.com/apidoc

Initiates the OAuth 2.0 authorization code flow. Redirects the user to the DonationAlerts authorization page where they can log in and grant access to the application.

```APIDOC
## GET https://www.donationalerts.com/oauth/authorize

### Description
Initiates the OAuth 2.0 authorization code flow. Redirects the user to the DonationAlerts authorization page where they can log in and grant access to the application.

### Method
GET

### Endpoint
https://www.donationalerts.com/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (integer) - Required - The client ID received from DonationAlerts
- **redirect_uri** (string) - Required - The URL in your application where users will be sent after authorization
- **response_type** (string) - Required - Must be set to `code` to request an authorization code grant
- **scope** (string) - Required - A space-delimited list of scopes

```

--------------------------------

### POST /api/v1/merchandise_sale

Source: https://www.donationalerts.com/apidoc

Creates a new merchandise sale alert. This endpoint is part of the Merchandise Advertisement API. It requires authentication via a Bearer token and a request signature.

```APIDOC
## [POST] /api/v1/merchandise_sale

### Description
Creates a new merchandise sale alert. This API is a part of the Merchandise Advertisement API.

### Method
POST

### Endpoint
https://www.donationalerts.com/api/v1/merchandise_sale

### Parameters
#### Query Parameters
- **user_id** (integer) - Required - DonationAlerts' user ID to which this merchandise sale referenced
- **external_id** (string) - Required - Up to 32 characters long unique sale ID generated by the developer
- **merchant_identifier** (string) - Required - Merchant's ID on DonationAlerts
- **merchandise_identifier** (string) - Required - Merchant's merchandise ID which was bought by the customer
- **amount** (number) - Required - Grand total of the sale
- **currency** (string) - Required - One of the available currencies of merchandise sale indicating the currency of `amount`
- **bought_amount** (integer) - Optional - Total number of bought items. Default value: 1
- **username** (string) - Optional - The name of the customer
- **message** (string) - Optional - The message sent by the customer while purchasing the merchandise
- **signature** (string) - Required - Request signature

### Request Example
```
curl --location --request POST 'https://www.donationalerts.com/api/v1/merchandise_sale' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'user_id=3' \
--data-urlencode 'amount=100' \
--data-urlencode 'currency=RUB' \
--data-urlencode 'merchant_identifier=MARKET_GAMES_MAIL_RU' \
--data-urlencode 'merchandise_identifier=3372' \
--data-urlencode 'external_id=1' \
--data-urlencode 'bought_amount=2' \
--data-urlencode 'username=John' \
--data-urlencode 'message=This is a test message' \
--data-urlencode 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'
```

### Response
#### Success Response (201)
- **id** (integer) - The unique merchandise sale alert identifier
- **name** (string) - Type of the generated alert
- **external_id** (string) - Unique sale ID generated by the developer
- **username** (string, null) - The name of the customer. Or `null` if customer is unknown
- **message** (string, null) - The message sent by the customer while purchasing the merchandise. Or `null` if text was not provided
- **amount** (number) - Grand total amount of the sale
- **currency** (string) - The currency code of the merchandise sale (ISO 4217 formatted)
- **bought_amount** (integer) - Total number of bought items
- **is_shown** (integer) - A flag indicating whether the alert was shown in the streamer's widget
- **created_at** (string) - The date and time (YYYY-MM-DD HH.MM.SS formatted) when sale alert was created
- **shown_at** (string, null) - Date and time indicating when the alert was shown (YYYY-MM-DD HH.MM.SS formatted). Or `null` if the alert is not shown yet

#### Response Example
```
HTTP/1.1 201 Created
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Thu, 24 Sep 2020 11:36:14 GMT
```

```
{
    "data": {
        "id": 153,
        "name": "merchandise-sale",
        "external_id": 1,
        "username": "John",
        "message": "This is a test message",
        "amount": 100,
        "currency": "RUB",
        "bought_amount": 2,
        "created_at": "2020-11-15 11:36:14",
        "is_shown": 0,
        "shown_at": null
    }
}
```
```

--------------------------------

### JSON response body for merchandise sale alert

Source: https://www.donationalerts.com/apidoc

JSON body of the created sale alert. Contains id, name, external_id, username, message, amount, currency, bought_amount, created_at, is_shown, and shown_at fields.

```json
{
    "data": {
        "id": 153,
        "name": "merchandise-sale",
        "external_id": 1,
        "username": "John",
        "message": "This is a test message",
        "amount": 100,
        "currency": "RUB",
        "bought_amount": 2,
        "created_at": "2020-11-15 11:36:14",
        "is_shown": 0,
        "shown_at": null
    }
}
```

--------------------------------

### Advertisement

Source: https://www.donationalerts.com/apidoc

Information about advertisement for merchandises, including overview and interaction scheme.

```APIDOC
## Advertisement

### Description
Information about advertisement for merchandises, including overview and interaction scheme.

### Sections
- Merchandises
  - Overview
  - Interaction Scheme

```

--------------------------------

### Subscribe to private channels - curl request

Source: https://www.donationalerts.com/apidoc

POST request to subscribe to private channels. Requires the client ID and an array of channel names.

```bash
curl \
    -X POST https://www.donationalerts.com/api/v1/centrifuge/subscribe \
    -H "Authorization: Bearer <token>" \
    -H "Content-Type: application/json" \
    -d '{"channels":["$alerts:donation_<user_id>"], "client":"<uuidv4_client_id>"}'
```

--------------------------------

### POST /api/v1/merchandise

Source: https://www.donationalerts.com/apidoc

Creates a new merchandise. This API is a part of the Merchandise Advertisement API. It requires the streamer to have a variation for the Alerts widget with 'Custom alerts' type for custom alerts to display.

```APIDOC
## POST /api/v1/merchandise

### Description
Creates new merchandise. This API is a part of the [Merchandise Advertisement API](https://www.donationalerts.com/apidoc#advertisement__merchandises).

### Method
POST

### Endpoint
https://www.donationalerts.com/api/v1/merchandise

### Parameters
#### Query String
- **merchant_identifier** (string) - Required - Merchant's ID on DonationAlerts
- **merchandise_identifier** (string) - Required - Up to 16 characters long unique merchandise ID generated by the merchant
- **title** (array) - Required - Array of up to 1024 characters long strings representing the name of the merchandise in different [locales](https://www.donationalerts.com/apidoc#introduction__http_api_requests__locales). At minimum, a title for the `en_US` locale is required
- **is_active** (integer) - Optional - A value containing 0 or 1. Determines whether the merchandise is available for purchase or not. Default value: 0
- **is_percentage** (integer) - Optional - A value containing 0 or 1. Determines whether the `price_service` and `price_user` parameters are recognized as amounts in a currency of the `currency` parameter or calculated as a percent of the sale's total. Default value: 0
- **currency** (string) - Required - One of the [available currencies](https://www.donationalerts.com/apidoc#introduction__http_api_requests__currencies) of merchandise. All revenue calculations will be performed according this value
- **price_user** (number) - Required - Amount of revenue added to streamer for each sale of the merchandise
- **price_service** (number) - Required - Amount of revenue added to DonationAlerts for each sale of the merchandise
- **url** (string) - Optional - Up to 128 characters long URL to the merchandise's web page. You may include the `{user_id}` and `{user_merchandise_promocode}` patterns in the URL that will be replaced in a UI with the user's ID and user's merchandise promocode
- **img_url** (string) - Optional - Up to 128 characters long URL to the merchandise's image
- **end_at_ts** (integer) - Optional - Date and time when the merchandise becomes inactive represented as Unix timestamp
- **signature** (string) - Required - Request [signature](https://www.donationalerts.com/apidoc#introduction__http_api_requests__request_signatures)

### Request Example
```
curl --location --request POST 'https://www.donationalerts.com/api/v1/merchandise' \
--header 'Authorization: Bearer <token>' \
--form 'merchant_identifier=MARKET_GAMES_MAIL_RU' \
--form 'merchandise_identifier=8082' \
--form 'title[en_US]=Credit case' \
--form 'title[ru_RU]=Кредитный кейс' \
--form 'is_active=1' \
--form 'is_percentage=1' \
--form 'currency=USD' \
--form 'price_user=30' \
--form 'price_service=15' \
--form 'url=https://market.games.mail.ru/game/1?product_id=8082&user_id={user_id}' \
--form 'img_url=https://market.games.mail.ru/s3/media/product/picture/2020/7/a5077d65bed0439dd78a01d12cee948d.png' \
--form 'signature=0d02b19c49ebbefb86d6bfa8b250d597da8e31a612ec57c315160a0ddc1a76f6'
```

### Response
#### Success Response (201)
- **id** (integer) - Required - Unique merchandise ID on DonationAlerts
- **merchant** (object) - Required - Object carrying `identifier` and `name` fields that contains information about the merchant
- **identifier** (string) - Required - Unique merchandise ID on the merchant's online store
- **title** (object) - Required - Object carrying merchandise's titles in different locales
- **is_active** (integer) - Required - A flag indicating whether the merchandise is available for purchase or not
- **is_percentage** (integer) - Required - A flag indicating whether the `price_service` and `price_user` parameters should be recognized as absolute values of the `currency` currency or as a percent of the sale's total
- **currency** (string) - Required - The currency code of the merchandise (ISO 4217 formatted)
- **price_user** (number) - Required - Amount of revenue added to streamer for each sale of the merchandise
- **price_service** (number) - Required - Amount of revenue added to DonationAlerts for each sale of the merchandise
- **url** (string, null) - Required - URL to the merchandise's web page. Or `null` if URL is not set
- **img_url** (string, null) - Required - URL to the merchandise's image. Or `null` if image is not set
- **end_at** (string, null) - Required - Date and time indicating when the merchandise becomes inactive (YYYY-MM-DD HH.MM.SS formatted). Or `null` if end date is not set

#### Response Example
```
HTTP/1.1 201 Created
Server: nginx/1.13.5
Content-Type: application/json
Transfer-Encoding: chunked
Connection: keep-alive
Cache-Control: no-cache, private
Date: Thu, 15 Nov 2020 08:37:37 GMT
```

```
Tokens:
Raw