GetCourse API

https://getcourse.ru/help/api
Admin
GetCourse API is a REST API for importing and exporting user, order, payment, and group data from...
Tokens:6,871
Snippets:65
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Execute Deal Import via cURL

Source: https://getcourse.ru/help/api

Example command to send a deal import request to the GetCourse API using cURL.

```bash
curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "https://{account_name}.getcourse.ru/pl/api/deals" --data "action=add&key={secret_key}&params={params}"
```

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

### GET /pl/api/account/fields

Source: https://getcourse.ru/help/api

Retrieves the list of additional user and deal fields.

```APIDOC
## GET /pl/api/account/fields

### Description
Returns the list of additional user and deal fields.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/fields

### Parameters
#### Query Parameters
- **key** (string) - Required - Secret API key
- **action** (string) - Required - Must be set to 'Get'
```

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

### GET /pl/api/account/deals

Source: https://getcourse.ru/help/api

Initiates an export task for deals based on provided filters and returns an export key.

```APIDOC
## GET /pl/api/account/deals

### Description
Initiates a task to collect deal data based on specified filters and returns an export key for status checking and data retrieval.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/deals

### Parameters
#### Query Parameters
- **key** (string) - Required - Secret API key
- **created_at[from]** (string) - Optional - YYYY-MM-DD
- **created_at[to]** (string) - Optional - YYYY-MM-DD
- **status** (string) - Optional - Deal status (new, payed, cancelled, in_work, payment_waiting, part_payed, waiting_for_return, not_confirmed, pending)
- **payed_at[from]** (string) - Optional - YYYY-MM-DD
- **payed_at[to]** (string) - Optional - YYYY-MM-DD
- **finished_at[from]** (string) - Optional - YYYY-MM-DD
- **finished_at[to]** (string) - Optional - YYYY-MM-DD
- **status_changed_at[from]** (string) - Optional - YYYY-MM-DD
- **status_changed_at[to]** (string) - Optional - YYYY-MM-DD
- **user_in_group** (integer) - Optional - Group ID
- **user_id** (string) - Optional - User ID(s) separated by comma
```

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

### GET /pl/api/account/groups

Source: https://getcourse.ru/help/api

Retrieves a list of all user groups.

```APIDOC
## GET /pl/api/account/groups

### Description
Retrieves a list of all user groups including ID, name, and last added user timestamp.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/groups

### Parameters
#### Query Parameters
- **key** (string) - Required - Secret API key
```

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

### GET /pl/api/account/users

Source: https://getcourse.ru/help/api

Initiates an export task for users based on provided filters.

```APIDOC
## GET /pl/api/account/users

### Description
Initiates a task to collect user data based on specified filters. Returns an export key used to check status and retrieve data.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/users

### Parameters
#### Query Parameters
- **key** (string) - Required - Secret API key
- **created_at[from]** (string) - Optional - Start date (YYYY-MM-DD)
- **created_at[to]** (string) - Optional - End date (YYYY-MM-DD)
- **status** (string) - Optional - User status (active/in_base)
- **email** (string) - Optional - User email address
- **idgrouplist** (string) - Optional - Group IDs or ID_date format
```

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

### GET /pl/api/account/exports/{export_id}

Source: https://getcourse.ru/help/api

Checks the status of an export task and retrieves the data.

```APIDOC
## GET /pl/api/account/exports/{export_id}

### Description
Checks the status of a previously initiated export task and returns the data stream.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/exports/{export_id}

### Parameters
#### Path Parameters
- **export_id** (string) - Required - The export key returned from the initiation request

#### Query Parameters
- **key** (string) - Required - Secret API key
```

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

### GET /pl/api/account/payments

Source: https://getcourse.ru/help/api

Initiates an export task for payments based on provided filters and returns an export key.

```APIDOC
## GET /pl/api/account/payments

### Description
Initiates a task to collect payment data based on specified filters and returns an export key.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/payments

### Parameters
#### Query Parameters
- **key** (string) - Required - Secret API key
- **created_at[from]** (string) - Optional - YYYY-MM-DD
- **created_at[to]** (string) - Optional - YYYY-MM-DD
- **status** (string) - Optional - Payment status (expected, accepted, returned, tobalance, frombalance, returned_to_balance)
- **status_changed_at[from]** (string) - Optional - YYYY-MM-DD
- **status_changed_at[to]** (string) - Optional - YYYY-MM-DD
```

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

### Update Deal Status via API

Source: https://getcourse.ru/help/api

Example of the JSON structure required for updating a deal status, which must be base64 encoded before transmission.

```json
base64_encode
    {
    "user":{
        "email":"email@yopmail.com"
    },
    "deal":{
        "deal_number":"13667463",
        "deal_status":"new"
    }
}
```

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

### GET /pl/api/account/groups/{ID}/users

Source: https://getcourse.ru/help/api

Initiates an export task for users belonging to a specific group.

```APIDOC
## GET /pl/api/account/groups/{ID}/users

### Description
Initiates a task to collect user data for a specific group. Returns an export key.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/groups/{ID}/users

### Parameters
#### Path Parameters
- **ID** (string) - Required - The ID of the group

#### Query Parameters
- **key** (string) - Required - Secret API key
```

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

### GET /pl/api/account/exports/{export_id}

Source: https://getcourse.ru/help/api

Checks the status of an export task and retrieves the data stream.

```APIDOC
## GET /pl/api/account/exports/{export_id}

### Description
Checks the readiness status of an export task and returns the data stream in a JSON string.

### Method
GET

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/exports/{export_id}

### Parameters
#### Path Parameters
- **export_id** (string) - Required - The export key returned by the initial request

#### Query Parameters
- **key** (string) - Required - Secret API key
```

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

### Add User via API in PHP

Source: https://getcourse.ru/help/api

Demonstrates how to add a user to GetCourse using cURL in PHP, including setting user fields and encoding parameters.

```php
<?php
$accountName = 'XXXXXX';
$secretKey = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
 
$user = [];
$user['user']['email'] = 'xxxxx@xxxxx.xxx';
$user['user']['phone'] = '+74951234567';
$user['user']['first_name'] = 'Василий';
$user['user']['last_name'] = 'Пупкин';
$user['user']['city'] = 'Москва';
$user['user']['country'] = 'Россия';
$user['user']['group_name'] = ['Группа1', 'Группа2'];
$user['system']['refresh_if_exists'] = 1;
 
$json = json_encode($user);
$base64 = base64_encode($json);
 
if( $curl = curl_init() ) {
	curl_setopt($curl, CURLOPT_URL, 'https://' . $accountName . '.getcourse.ru/pl/api/users');
	curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
	curl_setopt($curl, CURLOPT_POST, true);
	curl_setopt($curl, CURLOPT_POSTFIELDS, 'action=add&key=' . $secretKey . '&params=' . $base64);
	$out = curl_exec($curl);
	echo $out;
	curl_close($curl);
} else {
	echo 'Failed initialization';
}
?>
```

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

### Import User via cURL

Source: https://getcourse.ru/help/api

Use this cURL command to add a user by sending an action, secret key, and parameters to the user import endpoint.

```bash
curl -i -H «Accept: application/json; q=1.0, */*; q=0.1» «https://{account_name}.getcourse.ru/pl/api/users» -d «action=add&key={secret_key}&params={params}»
```

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

### Perform API Request via cURL

Source: https://getcourse.ru/help/api

Use this command to interact with the GetCourse API. Ensure the account domain is updated if a custom domain redirect is configured.

```bash
curl -i -H «Accept: application/json; q=1.0, */*; q=0.1» «https://{account_name}.getcourse.ru/pl/api/account/fields» -d «action=get&key={secret_key}»
```

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

### POST https://{account_name}.getcourse.ru/pl/api/deals (Add Deal)

Source: https://getcourse.ru/help/api

Imports a new deal into the system associated with a specific user.

```APIDOC
## POST https://{account_name}.getcourse.ru/pl/api/deals

### Description
Adds a new deal for a user.

### Method
POST

### Endpoint
https://{account_name}.getcourse.ru/pl/api/deals

### Parameters
#### Request Body
- **action** (string) - Required - Must be 'add'
- **key** (string) - Required - Secret API key
- **params** (string) - Required - Base64 encoded JSON object containing deal and user parameters.
```

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

### POST https://{account_name}.getcourse.ru/pl/api/users (Add/Update User)

Source: https://getcourse.ru/help/api

Imports or updates a user in the system. If the user does not exist, a new one is created. If the user exists and refresh_if_exists is set to 1, the user data is updated.

```APIDOC
## POST https://{account_name}.getcourse.ru/pl/api/users

### Description
Imports or updates user data. Requires base64 encoded JSON parameters.

### Method
POST

### Endpoint
https://{account_name}.getcourse.ru/pl/api/users

### Parameters
#### Request Body
- **action** (string) - Required - Must be 'add'
- **key** (string) - Required - Secret API key
- **params** (string) - Required - Base64 encoded JSON object containing user, system, and session details.
```

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

### User Import Data Structure

Source: https://getcourse.ru/help/api

JSON structure for user import parameters, which must be base64 encoded before transmission.

```json
base64_encode
    {
        "user":{
            "email":"email",
            "phone":"телефон",
            "first_name":"имя",
            "last_name":"фамилия",
            "city":"город",
            "country":"страна",
            "group_name":[ // для добавления пользователя в группы
                "Группа1", // простое добавление в групп
                ["Группа2", "2018-08-01 21:21"], // добавление в группу с указанием произвольного момента
                ["Группа4", "2018-08-02"]
            ],
            "addfields":{"Доп.поле1":"значение","Доп.поле2":"значение"} // для добавления дополнительных полей пользователя
        },
        "system":{
            "refresh_if_exists":0, // обновлять ли существующего пользователя 1/0 да/нет
            "partner_email":"email партнера (для пользователя)*"
        },
        "session":{
            "utm_source":"",
            "utm_medium":"",
            "utm_content":"",
            "utm_campaign":"",
            "utm_group":"",
            "gcpc":"",
            "gcao":"",
        }
    }
```

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

### POST /pl/api/users

Source: https://getcourse.ru/help/api

Adds or updates a user in the GetCourse system. Requires an action parameter set to 'add', a secret key, and a base64-encoded JSON object containing user profile information.

```APIDOC
## POST /pl/api/users

### Description
Adds a new user or updates an existing user profile. The user data must be passed as a base64-encoded JSON string.

### Method
POST

### Endpoint
https://{account_name}.getcourse.ru/pl/api/users

### Parameters
#### Request Body (encoded in 'params' field)
- **user** (object) - Required - User profile fields (email, phone, first_name, last_name, city, country, group_name)
- **system** (object) - Optional - System settings (e.g., refresh_if_exists)

### Request Example
{
  "action": "add",
  "key": "YOUR_SECRET_KEY",
  "params": "base64_encoded_json_string"
}
```

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

### POST /pl/api/deals

Source: https://getcourse.ru/help/api

Imports or updates a deal. If the user does not exist, they are created. If the deal number exists, the deal is updated.

```APIDOC
## POST /pl/api/deals

### Description
Imports or updates a deal in the system. Requires a base64 encoded JSON payload containing user, system, and deal information.

### Method
POST

### Endpoint
https://{account_name}.getcourse.ru/pl/api/deals

### Parameters
#### Request Body
- **action** (string) - Required - Must be set to "add"
- **key** (string) - Required - The secret API key
- **params** (string) - Required - Base64 encoded JSON string containing the deal data structure (user, system, session, deal objects)

### Request Example
curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "https://{account_name}.getcourse.ru/pl/api/deals" --data "action=add&key={secret_key}&params={base64_encoded_json}"
```

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

### API Request Structure

Source: https://getcourse.ru/help/api

Describes the standard format for making POST requests to the GetCourse API.

```APIDOC
## POST API Request

### Description
All API interactions are performed via HTTPS POST requests. Authentication and parameters are passed directly in the request body.

### Parameters
- **key** (string) - Required - The secret API key generated in the GetCourse account settings.
- **action** (string) - Required - The specific API action to be performed.
- **params** (string) - Required - A base64-encoded JSON string containing the parameters required for the specific action.
```

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

### Deal Import JSON Structure

Source: https://getcourse.ru/help/api

The JSON schema required for the 'params' field when importing or updating a deal.

```json
base64_encode
    {
        "user":{
            // как в импорте пользователя
        },
        "system":{
            "refresh_if_exists":0, // обновлять ли существующего пользователя 1/0 да/нет
            "partner_email":"email партнера (для пользователя)*",
            "multiple_offers":0, // добавлять несколько предложений в заказ 1/0
            "return_payment_link":0, // возвращать ссылку на оплату 1/0
            "return_deal_number":0 // возвращать номер заказа 1/0
        },
        "session":{
            // как в импорте пользователя
        },
        "deal":{
            "deal_number":"номер заказа",
            "offer_code":"уникальный код предложения",
            "offer_id":"ID предложения",
            "product_title":"наименование предложения",
            "product_description":"описание продукта",
            "quantity":1, // количество
            "deal_cost":"сумма заказа",
            "deal_status":"код статуса заказа",
            "deal_is_paid": "нет", // оплачен да/нет 1/0
            "manager_email":"email менеджера",
            "deal_created_at":"дата заказа",
            "deal_finished_at":"дата оплаты/завершения заказа",
            "deal_comment":"комментарий",
            "payment_type":"тип платежа из списка",
            "payment_status":"статус платежа из списка",
            "partner_email":"email партнера (для заказа)",
            "addfields":{"Доп.поле1":"значение","Доп.поле2":"значение"}, // для добавления дополнительных полей заказа
            "deal_currency":"код валюты заказа" // например, "EUR", параметр не является обязательным, если он не используется в запросе - валютой заказа будут рубли (RUB)
            "funnel_id":"ID доски продаж",
            "funnel_stage_id":"ID этапа на доске продаж"
        }
    }
```

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

### POST /pl/api/deals

Source: https://getcourse.ru/help/api

Updates the status of a deal (order) in the system. Requires an action parameter set to 'add', a secret key, and a base64-encoded JSON object containing user and deal details.

```APIDOC
## POST /pl/api/deals

### Description
Updates the status of a deal (order) in the system. Note that changing a deal status to 'payed' will create a payment record.

### Method
POST

### Endpoint
https://{account_name}.getcourse.ru/pl/api/deals

### Parameters
#### Request Body (encoded in 'params' field)
- **user** (object) - Required - Contains user identification (e.g., email)
- **deal** (object) - Required - Contains deal information (deal_number, deal_status)

### Request Example
{
  "action": "add",
  "key": "YOUR_SECRET_KEY",
  "params": "base64_encoded_json_string"
}
```

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

### POST /pl/api/account/fields

Source: https://getcourse.ru/help/api

Retrieves account fields using a cURL request. Note that if a custom domain is configured, it should be used instead of the system account address.

```APIDOC
## POST /pl/api/account/fields

### Description
Retrieves account fields from the GetCourse platform.

### Method
POST

### Endpoint
https://{account_name}.getcourse.ru/pl/api/account/fields

### Parameters
#### Request Body
- **action** (string) - Required - Must be set to "get"
- **key** (string) - Required - The secret API key for authentication
```

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

### Update User Groups Data Structure

Source: https://getcourse.ru/help/api

JSON structure for updating user group memberships, requiring the user ID and the list of groups.

```json
base64_encode
    {
    "user":{
        "id":"id пользователя",
        "group_name": ["Группа 1", "Группа 2"] // список групп
    }
} 
```

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

### API Response Format

Source: https://getcourse.ru/help/api

Describes the standard JSON response structure returned by the API.

```APIDOC
## API Response

### Description
The API returns a JSON object indicating the success of the request and the result of the action.

### Response Fields
- **success** (boolean) - Indicates if the API call was successful.
- **action** (string) - The name of the action that was executed.
- **result** (object) - Contains the specific output of the action, including potential error messages or entity IDs.
```

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

### POST https://{account_name}.getcourse.ru/pl/api/users (Update User Groups)

Source: https://getcourse.ru/help/api

Updates the group memberships for a specific user. The user will be added to the specified groups and removed from any groups not included in the list.

```APIDOC
## POST https://{account_name}.getcourse.ru/pl/api/users

### Description
Updates user group memberships. The user will only belong to the groups provided in the request.

### Method
POST

### Endpoint
https://{account_name}.getcourse.ru/pl/api/users

### Parameters
#### Request Body
- **action** (string) - Required - Must be 'update'
- **key** (string) - Required - Secret API key
- **params** (string) - Required - Base64 encoded JSON object containing user id and group_name list.
```

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

### API Response JSON Structure

Source: https://getcourse.ru/help/api

The standard JSON format returned by the API, containing success status, the action performed, and the result object.

```json
{
        "success":"true/false", // результат вызова
        "action":"вызванное действие",
        "result":{
            "deal_id":"уникальный id заказа",
            "deal_number":"номер заказа",
            "success":"true/false", // результат действия
            "user_id":"id пользователя",
            "user_status":"статус пользователя",
            "payment_link":"ссылка на страницу оплаты",
            "error_message":"сообщение об ошибке",
            "error":"true/false", // наличие ошибок
        }
    }
```
Tokens:
Raw