https://github.com/phpenterprise/rd-station-api

API de integração com o RD Station
https://github.com/phpenterprise/rd-station-api

api-client php56 rd-station

Last synced: 12 months ago
JSON representation

API de integração com o RD Station

• Host: GitHub
• URL: https://github.com/phpenterprise/rd-station-api
• Owner: phpenterprise
• License: gpl-2.0
• Created: 2015-10-19T01:38:09.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2019-06-10T17:19:34.000Z (almost 7 years ago)
• Last Synced: 2025-04-09T20:00:55.060Z (12 months ago)
• Topics: api-client, php56, rd-station
• Language: PHP
• Homepage: https://rdstation.com.br
• Size: 42 KB
• Stars: 4
• Watchers: 0
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# RD Station API [Deprecated]

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

[![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.svg?v=103)](https://opensource.org/licenses/GPL-3.0/) [![PHPPackages Rank](http://phppackages.org/p/smartdealer/sdapi/badge/rank.svg)](http://phppackages.org/p/phpenterprise-dev/rd-station-api) ![](https://reposs.herokuapp.com/?path=phpenterprise-dev/rd-station-api&style=flat)

### 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

~~~.php

// 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