Skip to content

phpenterprise/rd-station-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RD Station API [Deprecated]

API de integração simplificada com a plataforma RD Station

GPL Licence PHPPackages Rank

Requísitos

  • PHP 5.3 ou superior
  • Extensões do PHP "php_curl" e "php_openssl"
  • Apache 2.2+

Download via composer

composer require phpenterprise-dev/rd-station-api:dev-master

Exemplo de uso

// include lib
require '../src/rdstation/api.php';

// authentication (set your RD Station user)
$api = New \RdStation\Api('{user@example.com}', '{pass}', '{session_key:optional}');

// call method (for get leads totals) 
$a = $api->getMetrics();
        
// debug
var_dump($a);

# example of response
# int(1403)

Instância

  • Api (user, pass, session_key)
Parâmetro tipo descrição
user string email do usuário RD Station
senha string senha do usuário
session_key integer chave da sessão (opcional)

A chave da sessão possibilida multiplas sessões na plataforma.

Métodos

  • API : getMetrics

    Retorna o total da base de leads

  • API : getVisitors

    Retorna o total de visitas no mês

  • API : exportLeads (query:string)

    Exporta todas as leads armazenadas na base (array de dados)

Parâmetros

Posição tipo descrição
1 (query) string texto para filtro das leads (opcional)

Dependendo da quantidade de leads, este prodecimento poderá levar mais 5 minutos

  • API : outputCSV

    Compila os registros exportados em arquivo CSV

Campos

coluna tipo descrição
name string nome
mail string email
phone string telefone
origin string tag ou identificador do evento
uf string estado (ex: SP)
  • API : logout

    Fecha a sessão do usuário

Atualização regular.

@Release 1.7 (12/2017, stable)

Nota da versão: API Experimental

"VII billion Alicubi inter populum, ut semper aliquis est magis quam vobis" $P

Releases

No releases published

Packages

No packages published

Languages