rankim-software/rankim-api

Api de integração Rankim (PHP)

Api de integração Rankim (PHP)

Integração com a plataforma de marketing e CRM Rankim, _(*1)

, _(*2)

Para mais informações, acesse o nosso site., _(*3)

Direitos reservados à Rankim Soluções de Software Ltda., _(*4)

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, _(*5)

// include autoload (direct, not needed by Composer) include '../src/autoload.php';, _(*6)

OR, _(*7)

// if use composer (autoload) require DIR . '/vendor/autoload.php';, _(*8)

// instance API $api = new \Rankim\Api('{id}', '{access_token}');, _(*9)

// get real estate listing $data = $api->get('wallet');, _(*10)

// check errors if ($api->getError()) { var_dump($api->getError()); }, _(*11)

// the output (array) var_dump($data);, _(*12)

### 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, _(*13)

Atualização regular

@Release 1.1.2/2018, _(*14)