README

GetCourse.ru 库，用于访问 API

许可证：Apache2

系统要求

PHP 8.0+
PHP cURL 扩展支持 SSL（通常已包含）。
PHP JSON 扩展

安装

如果您使用 Composer，请将以下内容添加到您的 "composer.json" 文件中

  "require": {
     "xdemonme/getcourse-php-sdk": "^0.0.2"
  }

然后运行 composer update 以进行安装

或者

在您的项目命令行中运行以下命令

composer require xdemonme/getcourse-php-sdk

使用示例

位于 sample 目录中

协议文档

协议

API 功能仅通过 ssl 协议（https）访问

认证

认证需要将秘密密钥作为 POST 请求的 key 参数传递

操作

操作通过 POST 请求的 action 参数传递

参数

参数以 base64 编码的 JSON 字符串格式作为 POST 请求的 params 参数传递

导入用户的调用格式

用户导入位于 https://{account_name}.getcourse.ru/pl/api/users

要添加用户，需要传递操作 add、秘密密钥以及添加用户的参数：curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "https://{account_name}.getcourse.dev/pl/api/users" --data "action=add&key={secret_key}¶ms={params}"

用户参数

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

交易导入的调用格式

交易导入位于 https://{account_name}.getcourse.ru/pl/api/deals

要添加交易，需要传递操作 add、秘密密钥以及添加交易和用户的参数：curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "https://{account_name}.getcourse.dev/pl/api/deals" --data "action=add&key={secret_key}¶ms={params}"

交易参数应包括用户参数以及附加的交易参数，键为 deal

	base64_encode(
		{
			"user":{
				// как в импорте пользователя
			},
			"system":{
				// как в импорте пользователя
			},
			"session":{
				// как в импорте пользователя
			},
			"deal":{
				"deal_number":"номер заказа",
				"offer_code":"уникальный код предложения",
				"product_title":"наименование предложения",
				"product_description":"описание предложения",
				"quantity":1, // количество
				"deal_cost":"сумма заказа",
				"deal_is_paid":"оплачен да/нет"
				"manager_email":"email менеджера",
				"deal_created_at":"дата заказа",
				"deal_finished_at":"дата оплаты/завершения заказа",
				"deal_comment":"комментарий",
				"payment_type":"тип платежа из списка",
				"payment_status":"статус платежа из списка",
				"addfields":{"Доп.поле1":"значение","Доп.поле2":"значение"} // для добавления дополнительных полей заказа
			}
		});

发送消息的调用格式

消息发送位于 https://{account_name}.getcourse.ru/pl/api/messages

要发送消息，需要传递操作 send、秘密密钥以及发送消息的参数：curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "https://{account_name}.getcourse.dev/pl/api/messages" --data "action=send&key={secret_key}¶ms={params}"

发送消息的参数应包括

	base64_encode(
		{
			"message":{
				"email":"email пользователя",
				"transport":"email", // тип транспорта
				"mailing_id":"id рассылки",
				"params":{"поле шаблона 1":"значение","поле шаблона 2":"значение"} // можно переопределить поля шаблона, например first_name
			}
		});

响应格式

响应以 JSON 格式返回

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

xdemonme / getcourse-php-sdk

维护者

详情