Entendendo a API Aberta do Lead Gen & CRM: Código de Exemplo

Última atualização: 9 de outubro de 2024


Um método comum de conectar-se a APIs é usando a utilidade de baixo nível cURL. Este artigo fornecerá um código de exemplo para a API Aberta do Lead Gen & CRM.

Conteúdo do Artigo

 
 
Usuários:
Administradores ✓  
Gerentes de Empresa    
Gerentes de Marketing    
Gerentes de Vendas    
Vendedores    
Vendedores Jr.    

Informações Adicionais da API

Este artigo fornece um exemplo de como estruturar o código para a API do Lead Gen & CRM. No entanto, dada a extensão e o escopo da API, as informações são divididas e contidas em diferentes artigos. Cada artigo foca em uma função específica da API do Lead Gen & CRM. Informações adicionais da API podem ser encontradas nos seguintes artigos:

Exemplo de Código .PHP

O seguinte código é um exemplo que demonstra uma solicitação à API do Lead Gen & CRM usando .PHP. O tipo de conteúdo para a solicitação é definido manualmente como JSON, e os dados são codificados em formato JSON.

Nota: Constant Contact oferece Serviços Profissionais para ajudar com codificação personalizada e problemas de API.

<?php
   /** Obter todos os leads com um limite de 500 resultados */

   $limit = 500;                                                                         
   $offset = 0;                                                                          
                                                                                          
   $method = 'getLeads';                                                                 
   $params = array('where' => array(), 'limit' => $limit, 'offset' => $offset);          
   $requestID = session_id();       
   $accountID = '';
   $secretKey = '';                                                     

   $data = array(                                                                                
       'method' => $method,                                                                      
       'params' => $params,                                                                      
       'id' => $requestID,                                                                       
   );                                                                                            
                                                                                                 
   $queryString = http_build_query(array('accountID' => $accountID, 'secretKey' => $secretKey)); 
   $url = "http://api.sharpspring.com/pubapi/v1/?$queryString";                             
                                                                                                 
   $data = json_encode($data);                                                                   
   $ch = curl_init($url);                                                                        
   curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");                                              
   curl_setopt($ch, CURLOPT_POSTFIELDS, $data);                                                  
   curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);                                               
   curl_setopt($ch, CURLOPT_HTTPHEADER, array(                                                   
       'Content-Type: application/json',                                                         
       'Content-Length: ' . strlen($data)                                                        
   ));                                                                                           
                                                                                                 
   $result = curl_exec($ch);                                                                     
   curl_close($ch);                                                                              
                                                                                                 
   echo $result; 

?>  

 

Estrutura para Cláusulas Where

O seguinte código é um exemplo de como usar a cláusula where:
 

{
    "method": "getLeads",
    "params": {
        "where": {
        	"id": [1, 2, 3, 4]
        }
    },
    "id": 123
}

 

Estrutura para createLeads

O seguinte código é um exemplo de como usar o createLeads método para criar um lead no Lead Gen & CRM:
 

{
  "method":"createLeads",
  "params":
    {"objects":
      [
        {"firstName":"john","lastName":"smith","emailAddress":"john@smith.com"},
        {"firstName":"jane","lastName":"doe","emailAddress":"jane@doe.com"}
      ]
      
    },
  "id":"<seu ID de solicitação>"
}

 

Estrutura para updateLeads

O seguinte código é um exemplo de como usar o updateLeads método para atualizar leads já existentes no Lead Gen & CRM:
 

{
  "method":"updateLeads",
  "params":
    {"objects":
      [
        {"id":"<ID do lead>","firstName":"fooUpdate","lastName":"barUpdate"}
      ]
    },
  "id":"<seu ID de solicitação>"
}

 

Estrutura para deleteLeads

O seguinte código é um exemplo de como usar o deleteLeads método para deletar leads no Lead Gen & CRM:
 

{
  "method":"deleteLeads",
  "params":
  {"objects":
    [
      {"id":"<ID do lead>"},
      {"id":"<outro ID do lead>"},
    ]
  },
  "id":"<seu ID de solicitação>"
}
 

Outros artigos