Catatan blog

Dokumentasi API

Tautan lokasi di halaman ini: #one

Impor pengguna:

Metode ini dimaksudkan untuk mengimpor data, dan bukan untuk manajemen operasional objek!

Impor pengguna terletak di:

https://{account_name}.getcourse.id/pl/api/users

Untuk menambahkan pengguna, Anda perlu melewati aksi add, secret key, dan parameter pengguna yang akan ditambahkan.

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}¶ms={params}"

Parameter Pengguna:

base64_encode
    {
        "user":{
            "email":"email",
            "phone":"phone",
            "first_name":"name",
            "last_name":"last name",
            "city":"city",
            "country":"country",
            "group_name":[ // to add a user to groups
                "Group1", // simple addition to groups
                ["Group2", "2018-08-01 21:21"], // adding to the group indicating an arbitrary moment
                ["Group4", "2018-08-02"]
            ],
            "addfields":{"Additional field1":"value","Additional field2":"value"} // to add additional user fields
        },
        "system":{
            "refresh_if_exists":0, //whether to update an existing user 1/0 yes/no
            "partner_email":"partner email (for user)*"
        },
        "session":{
            "utm_source":"",
            "utm_medium":"",
            "utm_content":"",
            "utm_campaign":"",
            "utm_group":"",
            "gcpc":"",
            "gcao":"",
            "referrer":""
        }
    }

Jika pengguna dengan email yang ditentukan tidak ada dalam sistem, pengguna baru akan dibuat.

Jika pengguna sudah ada dan system.refresh_if_exists == 1, data pengguna akan diperbarui, dan daftar grupnya akan dilengkapi dengan grup yang ditentukan dalam parameter user.group_name. Jika bendera ini tidak diatur, maka tidak ada data pengguna yang akan berubah.

Data dari objek sesi/session akan ditangkap sebagai parameter pendaftaran pengguna baru. Jika ada pembaruan data (hanya dengan system.refresh_if_exists == 1), maka data sebelumnya akan digantikan.

Anda dapat menetapkan mitra untuk seorang pengguna dengan dua cara yang berbeda:

a) menggunakan parameter system.partner_email;

b) menggunakan parameter session.gcpc (memiliki prioritas yang lebih tinggi).

Jika mitra yang ditentukan untuk pengguna yang dibuat/diperbarui ada, pengguna dalam sistem akan ditandai sebagai rujukan dari mitra tersebut. Jika pengguna mitra tidak ada, akan dikembalikan pesan kesalahan. Jika pengguna mitra ada tetapi bukan mitra, maka pengguna yang ditentukan akan secara otomatis diberi status mitra.

Tautan lokasi di halaman ini: #two

IMPOR PESANAN

Metode ini dimaksudkan untuk mengimpor data, bukan untuk manajemen operasional objek!

Transaksi impor terletak di:

https://{nama_akun}.getcourse.id/pl/api/deals

Untuk menambahkan transaksi, Anda perlu melewati tindakan add, kunci rahasia, parameter transaksi, dan parameter pengguna untuk siapa transaksi tersebut dibuat:

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}¶ms={params}"

base64_encode
    {
        "user":{
            // as in user import
        },
        "system":{
            "refresh_if_exists":0, //whether to update an existing user 1/0 yes/no
            "partner_email":"partner email (for user)*",
            "multiple_offers":0, // add multiple offers to an order 1/0
            "return_payment_link":0, // return payment link 1/0
            "return_deal_number":0 // return order number 1/0
        },
        "session":{
            // as in user import
        },
        "deal":{
            "deal_number": "order number",
            "offer_code": "unique offer code",
            "product_title":"offer name",
            "product_description":"offer description",
            "quantity":1, // quantity
            "deal_cost": "order amount",
            "deal_status": "order status code",
            "deal_is_paid": "no", // paid yes/no 1/0
            "manager_email": "manager email",
            "deal_created_at": "order date",
            "deal_finished_at": "payment/order completion date",
            "deal_comment":"comment",
            "payment_type": "payment type from the list",
            "payment_status": "payment status from the list",
            "partner_email":"partner's email (for ordering)",
            "addfields":{"Additional field1":"value","Additional field2":"value"}, // to add additional order fields
            "deal_currency":"order currency code" // for example, "EUR", the parameter is optional, if it is not used in the request - the order currency will be rubles (RUB)
            "funnel_id":"Sales board ID",
            "funnel_stage_id": "Sales board stage ID"
        }
    }

Untuk mengimpor transaksi, pengguna harus ada - pemilik transaksi.
Jika pengguna yang dilewatkan tidak ada, maka akan dibuat.
Jika ada pengguna dengan email yang ditentukan, maka dia akan digunakan sebagai pemilik pesanan.
Jika parameter system.refresh_if_exists == 1 dilewatkan dan pengguna ada, maka data pengguna akan diperbarui dengan cara yang sama seperti operasi impor pengguna (dengan pengecualian objek sesi - lihat di bawah)

Ketika mengimpor transaksi, dilakukan pengecekan apakah transaksi dengan nomor yang ditentukan ada.
Tergantung pada hal ini, transaksi baru dibuat atau yang sudah ada diperbarui.
Jika system.multiple_offers flag == 1 dan pesanan yang sudah ada diperbarui, maka posisi yang ditransfer dalam transaksi ditambahkan ke yang sudah ada, bukan menggantikannya.

Parameter system.refresh_if_exists tidak memiliki efek pada pembuatan/pembaruan transaksi (parameter ini hanya digunakan untuk pengguna!)

Saat mengimpor transaksi, objek sesi/session berisi parameter UTM yang dicatat sebagai konteks pembuatan pesanan.
Selain itu, jika pengguna baru dibuat saat mengimpor transaksi, objek sesi juga digunakan sebagai konteks pendaftaran pengguna. Namun, saat memperbarui data pengguna saat mengimpor transaksi, objek sesi hanya digunakan untuk transaksi, bukan untuk pengguna.

Pesanan dapat menunjukkan mitra selain mitra pengguna. Mitra pesanan dapat ditetapkan dengan dua cara:
a) menggunakan parameter deal.partner_email;
b) menggunakan parameter session.gcpc (prioritas lebih tinggi).
Jika mitra yang ditentukan untuk transaksi ada, maka mitra ini akan ditetapkan untuknya.

Jika pengguna mitra tidak ada, maka akan dikembalikan pesan kesalahan.
Jika pengguna mitra ada tetapi bukan mitra, maka pengguna yang ditentukan akan secara otomatis diberi status mitra.