Download the PHP package xdemonme/getcourse-php-sdk without Composer

On this page you can find all versions of the php package xdemonme/getcourse-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of xdemonme/getcourse-php-sdk

Informations about the package getcourse-php-sdk

GetCourse-PHP-SDK

Библиотека GetCourse.ru для доступа к API

Лицензия: Apache2

Системные требования:

Установка

Если вы используете Composer, то добавьте в свой "composer.json":

и запустите composer update для установки

или

запустите эту команду в командной строке вашего проекта:

Пример использования

Находится в директории

Документация протокола

Протокол

Функции АПИ доступны только по ssl протоколу (https)

Авторизация

Для авторизации необходимо передать секретный ключ как параметр key POST запроса

Действие

Действие передается как параметр action POST запроса

Параметры

Параметры в формате base64 кодированной JSON строки передаются как параметр params POST запроса

Формат вызова импорта пользователя

Импорт пользователя находится по адресу

Для добавления пользователя необходимо передать действие add, секретный ключ и параметры добавляемого пользователя:

Параметры пользователя:

    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, секретный ключ и параметры добавляемого пользователя и сделки:

Параметры сделки должны включать параметры пользователя и дополнительно параметры сделки с ключом 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, секретный ключ и параметры отправляемого сообщения:

Параметры отправляемого сообщения должны включать:

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

All versions of getcourse-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
ext-curl Version *
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package xdemonme/getcourse-php-sdk contains the following files

Loading the files please wait ....