igor-sanches/neo-rede-sdk

SDK para integração com a API NeoRede.

v1.0.0 2025-09-11 13:23 UTC

Requires

• php: >=8.1
• ext-curl: *
• guzzlehttp/guzzle: ^7.10

MIT

• Igor D. Sanches

README

Uma integração rápida e eficaz com a API da NeoRede

Adicionar o SDK ao projeto

composer require igor-sanches/neo-rede-sdk

Etapas de configurações.

1. Credenciais
2. Criar Token NeoRede
3. Criar Pedido NeoRede
4. Atualizar Pedido NeoRede
5. Cancelar Pedido NeoRede
6. Completar Pedido NeoRede
7. Deletar Pedido NeoRede
8. Buscar Pedidos NeoRede
9. Detalhar Pedido NeoRede
10. Adicionar documento Pedido NeoRede
11. Atualizar documento Pedido NeoRede
12. Deletar documento Pedido NeoRede
13. Buscar documentos Pedido NeoRede
14. Validar Titularidade NeoRede
15. Gerar Token Electro
16. Validar Titularidade Electro

Credenciais

• Para o SDK se conectar a API é preciso adicionar as credencias.
• No seu projeto abra seu arquivo .env

• No Laravel

NEOENERGIA_URL="https://neoenergiaservicos--uatf.sandbox.my.salesforce.com"
NEOENERGIA_URL_TOKEN="https://neoenergiaservicos--uatf.sandbox.lightning.force.com"
NEOENERGIA_IP_NEO_REDE=http://IP_DA_NEO_REDE/validacaotitularidade/Validacao
NEOENERGIA_CLIENTE_ID=sua_key
NEOENERGIA_CLIENTE_SECRET=sua_key
NEOENERGIA_PID=sua_key

NEOENERGIA_ELECTRO_NEO_REDE=https://api-agencia.elektro.com.br
ELECTRO_GRANT_TYPE=sua_key
ELECTRO_USERNAME=sua_key
ELECTRO_PASSWORD=sua_key
ELECTRO_CLIENT_ID=sua_key

API_TIME_OUT=60

• Em PHP puro

putenv('NEOENERGIA_URL=https://neoenergiaservicos--uatf.sandbox.my.salesforce.com');
putenv('NEOENERGIA_URL_TOKEN=https://neoenergiaservicos--uatf.sandbox.lightning.force.com');
putenv('NEOENERGIA_IP_NEO_REDE=http://IP_DA_NEO_REDE/validacaotitularidade/Validacao');
putenv('NEOENERGIA_CLIENTE_ID=sua_key');
putenv('NEOENERGIA_CLIENTE_SECRET=sua_key');
putenv('NEOENERGIA_PID=sua_key');
putenv('NEOENERGIA_ELECTRO_NEO_REDE=https://api-agencia.elektro.com.br');
putenv('ELECTRO_GRANT_TYPE=sua_key');
putenv('ELECTRO_USERNAME=sua_key');
putenv('ELECTRO_PASSWORD=sua_key');
putenv('ELECTRO_CLIENT_ID=sua_key');
putenv('API_TIME_OUT=60');
 

Criar Token NeoRede

// use este método para retornar o access_token
$token = new NeoRedeSDK\Token();
$access_token = $token->getAccessToken();

Criar Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
$response = $order->createOrder([
            "cliente" => [
                "nome" => "Mike",
                "cpf_cnpj" => "578.478.480-31",
                "conta_contrato" => [
                    "codigo" => "9999999856",
                    "endereco" => [
                        "logradouro" => "Rua Dragon",
                        "numero" => "453",
                        "complemento" => "Bloco A",
                        "bairro" => "Bloco A",
                        "cidade" => "Natal",
                        "uf" => "RN",
                        "cep" => "50030000",
                    ],
                    "telefone" => [
                        "ddd" => "62",
                        "numero" => "999999856",
                        "tipo" => "Fixo",
                    ],
                    "distribuidora" => "Neoenergia - Cosern",
                ],
            ],
            "data" => "2025-01-01",
            "produto" => "Rede Assist",
            "valor" => 29.7,
            "de_acordo_privacidade" => true,
            "de_acordo_LGPD" => true,
            "proposta_numero" => "343443",
        ]);

$id = $response['id_salesforce'];

Atualizar Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
$response = $order->updateOrder([ 
            "data" => "2025-01-01",
            "produto" => "Rede Assist",
            "valor" => 29.7
        ]); 

Cancelar Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe o ID do pedido e o motivo do cancelamento
$response = $order->cancelOrder($id, "Solicitado pelo cliente"); 

Completar Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Pase o ID do pedido
$response = $order->completeOrder($id); 

Deletar Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe o ID do pedido
$response = $order->delete($id); 

Buscar Pedidos NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe a data de inicio e fim da consulta
$orders = $order->searchOrder('2025-01-01', '2025-03-01'); 

Detalhar Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe o ID
$orderDetails = $order->orderDetails($id); 

Adicionar documento Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe o ID
$response = $order->addDocumentOrder($id, [
            "nome" => "Contrato.mp3",
            "conteudo" => "QXJxdWl2byBkZSB0ZXN0ZQ==",
            "tipo" => "Áudio",
            "observacao" => "Observação da proposta"
        ]);

$idDocument = $response['id_salesforce'];

Atualizar documento Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe o ID do pedido e o ID do documento
$response = $order->updateOrderDocument($id, $idDocument, [
            "nome" => "Contrato.mp3",
            "conteudo" => "QXJxdWl2byBkZSB0ZXN0ZQ=="
        ]);

Deletar documento Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe o ID do pedido e o ID do documento
$response = $order->deleteRequestDocument($id, $idDocument);

Buscar documentos Pedido NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Order($access_token);
// Passe o ID do pedido
$response = $order->searchDocumentsRequest($id);

Validar Titularidade NeoRede

// Passe o access_token
$order = new NeoRedeSDK\Ownership($access_token);
// Passe o CPF/CNPJ, UC e a empresa
$response = $order->validateOwnership($cpf_cpnj, $uc, \NeoRedeSDK\enums\CompanyType::COSERN);

Gerar Token Electro

// Passe o access_token
$token = new NeoRedeSDK\Electro\Token();
$access_token = $token->getAccessToken();

Validar Titularidade Electro

// Passe o access_token
$order = new NeoRedeSDK\Electro\Ownership($access_token);
// Passe o CPF/CNPJ, UC e a empresa
$response = $order->validateOwnership($cpf_cpnj, $uc);