https://github.com/rankim-software/rankim-api
API de integração com a Rankim
https://github.com/rankim-software/rankim-api
curlphp php56 rankim-api
Last synced: 11 days ago
JSON representation
API de integração com a Rankim
- Host: GitHub
- URL: https://github.com/rankim-software/rankim-api
- Owner: rankim-software
- Created: 2015-07-04T02:49:47.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-08-01T18:10:43.000Z (over 7 years ago)
- Last Synced: 2025-03-13T04:29:18.282Z (11 months ago)
- Topics: curlphp, php56, rankim-api
- Language: PHP
- Homepage: http://rankim.com.br
- Size: 33.2 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Api de integração Rankim (PHP)
Integração com a plataforma de marketing e CRM Rankim
[](https://opensource.org/licenses/GPL-3.0/) [](http://phppackages.org/p/rankim-software/rankim-api) 
Para mais informações, acesse o nosso [site](http://rankim.com.br).
Direitos reservados à Rankim Soluções de Software Ltda.
### Requísitos
* PHP 5.3 ou superior
* Extensões do PHP "php_curl" e "php_openssl"
* Apache 2.2+
### Via composer
composer require rankim-software/rankim-api
### Instância da API
~~~.php
// include autoload (direct, not needed by Composer)
include '../src/autoload.php';
OR
// if use composer (autoload)
require __DIR__ . '/vendor/autoload.php';
// instance API
$api = new \Rankim\Api('{id}', '{access_token}');
// get real estate listing
$data = $api->get('wallet');
// check errors
if ($api->getError()) {
var_dump($api->getError());
}
// the output (array)
var_dump($data);
~~~~
### Parâmetros da instância da classe
Tradução dos parâmetros
| paràmetro | tipo | descrição |
| ------------- | -------------| ------------- |
| id | integer (11) | id do usuário da API
| access_token | string (40) | token de autenticação do usuário
### Funções da API
##### $api->auth()
Verificar se o ID e Token de usuários são válidos
##### $api->get('wallet')
Lista os imóveis da conta do usuário (retorno array)
##### $api->get('realty/123')
Trás informações de um imóvel específico na carteira (detalhes, imagens e características)
##### $api->put('lead', array())
Registra uma lead na sua conta (com ou sem campanha)
~~~.php
$api->put('lead', array(
'name' => 'nome do lead',
'email' => 'email do lead',
'phone' => 'telefone do lead',
'campaign' => 1 (opcional)
))
~~~~
##### $api->getError()
Mostra os erros de execução da API
### Atualização regular
@Release 1.1.2/2018