README

GetCourse.ru库，用于访问API

许可证：Apache2

系统要求

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

安装

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

  "repositories": [
        {
            "type": "git",
            "url": "https://github.com/getcourse-ru/GetCourse-PHP-SDK"
        }
    ],
  "require": {
     "getcourse-ru/GetCourse-PHP-SDK": "dev-master"
  }

使用示例

位于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", // наличие ошибок
			}
		}

inkshio / getcourse-php-sdk

维护者

详细信息