Skip to content
SDK para integração com a API E-Branvo Lojas Virtuais na linguagem PHP
PHP
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitignore
LICENSE
README.md
composer.json
phpunit.xml

README.md

ebranvo-php-sdk

SDK para integração com a API E-Branvo Lojas Virtuais na linguagem PHP

Sumário

  1. Primeiros Passos
  2. Cliente
    1. Inserir
    2. Atualizar
    3. Consultar
    4. Remover
  3. Endereço
    1. Inserir
    2. Atualizar
    3. Consultar
    4. Remover

Primeiros Passos

Esse sdk foi criado para ser de fácil manipulação.

Comece instanciando um objeto EbranvoSdk, como no exemplo abaixo:

$ebranvo = new \Ebranvo\EbranvoSdk(
    new \Ebranvo\Store('TOKEN AQUI'),
    new \Ebranvo\Environment('live ou sandbox')
);

Pronto, você já tem acesso às informações dessa loja.

Para isso, basta realizar uma chamada à um dos métodos: get, all, add ou del.

Cliente

Inserir

$response = $ebranvo->addCustomer([
    'type'=> 'PF',
    'name'=> 'Nome do Cliente',
    'document'=> '000.000.000-00',
    'phone'=> '(00) 0000-0000',
    'mail'=> 'email@exemplo.com',
    'birthDate'=> '0000-00-00',
    'gender'=> 1,
    'active'=> true,
    'addresses'=> [
        [
            'street'=> 'Rua exemplo',
            'number'=> '0',
            'complement'=> 'Sala 00',
            'district'=> 'Centro',
            'city'=> 'São Paulo',
            'state'=> 'SP',
            'postcode'=> '00000-000',
            'responsibleName'=> 'Nome do Responsável',
            'type'=> 1,
            'active'=> true
        ]
    ]
]);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Atualizar


// A presença do id indica que é uma operação de atualização
$response = $ebranvo->addCustomer([
    'id' => 123
    'active' => false
]);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Consultar

Consultar um registro

$response = $ebranvo->getCustomer($id = 123);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Consultar vários registros

$response = $ebranvo->allCustomers($page = 1);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Remover

$response = $ebranvo->delCustomer($id = 123);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Endereço

Inserir

$response = $ebranvo->addAddress([
    'idClient' => 123,
    'street'=> 'Rua exemplo',
    'number'=> '0',
    'complement'=> 'Sala 00',
    'district'=> 'Centro',
    'city'=> 'São Paulo',
    'state'=> 'SP',
    'postcode'=> '00000-000',
    'responsibleName'=> 'Nome do Responsável',
    'type'=> 1,
    'active'=> true
]);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Atualizar


// A presença do id indica que é uma operação de atualização
$response = $ebranvo->addAddress([
    'id' => 321
    'active' => false
]);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Consultar

Consultar um registro

$response = $ebranvo->getAddress($id = 321);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Consultar vários registros

$response = $ebranvo->allAddresses($idCustomer = 123);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}

Remover

$response = $ebranvo->delAddress($id = 321);

if ($response['success']) {
    echo $response['data'];
} else {
    echo $response['errorMessage'];
}
You can’t perform that action at this time.