A API do Ramper Pipeline permite que sistemas externos consultem, criem e atualizem dados como organizações, contatos e oportunidades, automatizando processos e integrando o CRM a outras ferramentas.

A documentação completa está disponível em: https://linkseller.docs.apiary.io/

Como obter o token de acesso

Acesse sua conta no Ramper Pipeline.
Clique no avatar do usuário, no canto superior direito.
Clique na opção API.
Copie o API Token exibido na tela.

O token deve ser enviado no header das requisições com o parâmetro access-token.

GET – Listar registros

Exemplo de como listar as oportunidades:

$access_token = '00000000-1111-2222-3333-444444444444'; // inclua o seu token
$url_api = 'https://api.lscrm.com.br/v1/opportunities';
$array_headers = array( "access-token: {$access_token}" );

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url_api);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $array_headers);
$response = curl_exec($ch);
curl_close($ch);

$array_retorno = json_decode($response, true);
print_r($array_retorno);

GET – Buscar registros com filtros

$array_parametros = array(
  'filters' => array(
    'title' => array('like' => 'teste'),
    'stage_id' => array('equal' => '1'),
  ),
  'order' => array('id', 'desc'),
);
$url_api .= '?' . urldecode(http_build_query($array_parametros));
// ...envie a requisição GET com os headers do exemplo anterior

POST – Criar oportunidade para Organização com Pessoa

$url_api = 'https://api.lscrm.com.br/v1/opportunities';
$array_dados = array(
  "title" => "Teste via API",
  "stage_id" => "3",
  "organizations" => array(
    "name" => "Organização de teste (via API)",
    "phone" => "(11) 91234-4567",
  ),
  "organizations_person" => array(
    "name" => "Pessoa de teste (via API)",
    "phone" => "(11) 91234-4567",
  ),
  "additional_values" => array(
    "opportunities" => array( "nome_do_campo" => "Valor 1" ),
  ),
);
// ...envie via POST (CURLOPT_POSTFIELDS = http_build_query($array_dados)) com o header access-token

POST – Criar oportunidade para Pessoa

$array_dados = array(
  "title" => "Teste via API",
  "stage_id" => "3",
  "persons" => array(
    "name" => "Pessoa de teste (API)",
    "phone" => "(11) 91234-4567",
  ),
);

Obs: ao adicionar, diversos campos são preenchidos automaticamente.

PUT – Adicionar ou editar nota em uma oportunidade

Faça uma requisição PUT para o endpoint de oportunidades informando o ID na URL, com os dados em application/x-www-form-urlencoded. Use o parâmetro add_note com o texto da nota. Exemplo de endpoint: https://api.lscrm.com.br/v1/opportunities/ID_DA_OPT

curl --location --request PUT 'https://api.lscrm.com.br/v1/opportunities/ID_DA_OPT' \
--header 'access-token: API_TOKEN_SECRET' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'add_note=teste de nota'

Substitua ID_DA_OPT pelo ID de uma oportunidade existente e API_TOKEN_SECRET pelo token de acesso da sua conta.