Importação de usuário

O método destina-se à importação de dados, não ao gerenciamento operacional de objetos!

A importação do usuário está localizada em:
https://{account_name}.getcour...

Para adicionar um usuário, você precisa passar uma ação add, chave secreta e parâmetros do usuário adicionado:

curl -i -H "Accept: application/json; q=1.0, */*; q=0.1" "https://{account_name}.getcourse.com.br/pl/api/users" ;-d "action=add&key={secret_key}&parаms={params}"

Parâmetros do usuário:

base64_encode
    {
        "user":{
            "email":"email",
            "phone":"telefone",
            "first_name":"nome",
            "last_name":"sobrenome",
            "city":"cidade",
            "country":"país",
            "group_name":[ // para adicionar usuarios no grupo
                "Grupo1", // adição simples a grupos
                ["Grupo2", "2018-08-01 21:21"], // adicionando ao grupo indicando um momento arbitrário
                ["Grupo4", "2018-08-02"]
            ],
            "addfields":{"Camp.adic1":"valor","Camp.adic2":"valor"} // para adicionar campos adicionais de usuário 
        },
        "system":{
            "refresh_if_exists":0, // se deve atualizar um usuário existente 1/0 sim/nao
            "partner_email":"e-mail de afiliado (para usuário)*"
        },
        "session":{
            "utm_source":"",
            "utm_medium":"",
            "utm_content":"",
            "utm_campaign":"",
            "utm_group":"",
            "gcpc":"",
            "gcao":"",
            "referer":""
        }
    }

Se não houver nenhum usuário com o e-mail especificado no sistema — um novo usuário será criado.

Se o usuário existir e system.refresh_if_exists == 1 — os dados do usuário serão atualizados e a lista de seus grupos será complementada com os grupos especificados no parâmetro user.group_name. Se este sinalizador não for definido, nenhum dado do usuário será alterado.

Os dados do objeto de sessão serão capturados como os novos parâmetros de registro do usuário. Se os dados estiverem sendo atualizados (apenas com system.refresh_if_exists == 1), os anteriores serão substituídos.

Você pode definir um afiliado para um usuário de duas maneiras diferentes:
a) usando o parâmetro system.partner_email;
b) usando o parâmetro session.gcpc (tem maior prioridade).

Se o afiliado especificado para o usuário criado/atualizado existir, o usuário no sistema será marcado como uma referência deste parceiro.
Se o usuário afiliado não existe — um erro será acontecerá.
Se um usuário afiliado existir, mas não for um afiliado, o usuário especificado receberá automaticamente o status de afiliado.

Pedido de importação (transação)

O método destina-se à importação de dados, não ao gerenciamento operacional de objetos!

A importação da transação está localizada em:

https://{account_name}.getcourse.com.br/pl/api/deals

Para adicionar uma oferta, você precisa passar a ação add, a chave secreta, os parâmetros da oferta, os parâmetros do usuário para quem a oferta está sendo criada:

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

base64_encode
    {
        "user":{
            // como na importação do usuário
        },
        "system":{
            "refresh_if_exists":0, // se deve atualizar um usuário existente 1/0 sim/nao
            "partner_email":"e-mail do afiliado (para usuário)*",
            "multiple_offers":0, // adicionar várias ofertas ao pedido 1/0
            "return_payment_link":0, // retornar link de pagamento 1/0
            "return_deal_number":0 // retornar o número da ordem 1/0
        },
        "session":{
            // como na importação do usuário
        },
        "deal":{
            "deal_number":"número do pedido",
            "offer_code":"código de oferta único",
            "product_title":"nome da oferta",
            "product_description":"descrição da oferta",
            "quantity":1, // quantidade
            "deal_cost":"preço do pedido",
            "deal_status":"código de status do pedido",
            "deal_is_paid":"pago sim/nao",
            "manager_email":"email do gerente",
            "deal_created_at":"data do pedido",
            "deal_finished_at":"data de pagamento/conclusão do pedido",
            "deal_comment":"comentário",
            "payment_type":"tipo de pagamento da lista",
            "payment_status":"status de pagamento da lista",
            "partner_email":"email do afiliado (para o pedido)",
            "addfields":{"Camp.adic1":"valor","Camp.adic2":"valor"}, // para adicionar mais campos de pedido
            "deal_currency":"código de moeda do pedido" // por exemplo, "EUR", o parâmetro é opcional se não for usado na solicitação - a moeda do pedido será em rublos (RUB)
        }
    }

Para importar uma oferta, um usuário deve existir — proprietário da transação.
Se o usuário passado não existir — ele é criado.
Se houver um usuário com o e-mail especificado, ele será usado como o proprietário do pedido.
Se o parâmetro system.refresh_if_exists == 1 E o usuário existir, então seus dados serão atualizados da mesma forma que a operação de importação do usuário (exceto para o objeto de sessão - veja abaixo)

Ao importar uma oferta, é verificado se existe uma oferta com o número especificado.
Dependendo disso, uma nova oferta é criada ou uma existente é atualizada.

Se o sinalizador system.multiple_offers == 1 e um pedido existente for atualizado, as posições transferidas na negociação serão adicionadas às existentes, em vez de substituí-las.

O parâmetro system.refresh_if_exists não tem efeito na criação / atualização de um negócio (este parâmetro é usado apenas para usuários!).

O objeto session ao importar uma transação contém parâmetros UTM que são capturados como contexto de criação de ordem.
Além disso, se um novo usuário for criado ao importar uma transação, o objeto session será usado da mesma forma que o contexto de registro do usuário. No entanto, ao atualizar os dados do usuário ao importar uma transação, o objeto session é usado apenas para a transação, não para o usuário.

O pedido pode ter uma referência a um afiliado diferente do afiliado do usuário. Um parceiro de pedido pode ser instalado de duas maneiras:
a) usando o parâmetro deal.partner_email;
b) usando o parâmetro session.gcpc (tem maior prioridade).

Se o afiliado especificado para a transação existir, esse parceiro será definido para ela.
Se o usuário afiliado não existe — um erro será retornado.

Se um usuário afiliado existir, mas não for um, o usuário especificado receberá automaticamente o status de afiliado.

Exemplo de adição de um usuário (PHP):


<?php
 $accountName = 'XXXXXX';
 $secretKey = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
 $user = [ ] ; 
 $user['user']['email'] = 'xxxxx@xxxxx.xxx';
 $user['user']['phone'] = '+554951234567';
 $user['user']['first_name'] = 'Carlos';
 $user['user']['last_name'] = 'Silva';
 $user['user']['city' ] = 'Manaus';
 $user['user']['country'] = 'Brasil';
 $user['user']['group_name'] = ['Grupo1', 'Grupo2'];
 $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.com.br/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'; 
 }
 ?>

Link para este endereço na página: #export

Link para este endereço na página: #users

Link para este endereço na página: #deals

Link para este endereço na página: #payments

Quais dados podem ser baixados via API