pablosanches/registrobr-epp

SDK não oficial de integração com os Correios

v1.0.4 2023-12-18 17:18 UTC

Requires

• ext-json: *
• ext-mbstring: *
• ext-simplexml: *

Requires (Dev)

• fakerphp/faker: *
• phpunit/phpunit: *
• squizlabs/php_codesniffer: *

MIT

• Pablo Sanches

README

Esta lib suporta as funções mais básicas do EPP criado pelo NIC.br e utilizadas no registrador do Registro.br

Pré-requisito

É necessário ser uma empresa validada e cadastrada no Registro.br

Contribua

Sinta-se livre para extender as funções disponibilizadas por esta lib. Documentação

Instalação

composer require pablosanches/registrobr-epp

Utilização

A lib usa por padrão o certificado fornecido pelo Registro.br para o ambiente de homologação. Para fornecer o seu certificado oficial você pode informar o caminho absoluto do arquivo no factory do EppClient;

Criando contato

$eppClient = EppClient::factory('user', 'password', '<caminho-absoluto-do-certificado.pem>');
$contact = ResourceFactory::factory($eppClient, 'contact');
$return = $contact->create([
    'name' => 'João da Silva',
    'street_1' => 'Rua das Laranjeiras',
    'street_2' => '100',
    'city' => 'São Paulo',
    'state' => 'SP',
    'zipcode' => '02127-000',
    'phone' => '+55.1122222222',
    'email' => '[e-mail]'
]);
var_dump($return->getResponse());

Criando contato

$eppClient = EppClient::factory('user', 'password');
$contact = ResourceFactory::factory($eppClient, 'contact');
$return = $contact->create([
    'name' => 'João da Silva',
    'street_1' => 'Rua das Laranjeiras',
    'street_2' => '100',
    'city' => 'São Paulo',
    'state' => 'SP',
    'zipcode' => '02127-000',
    'phone' => '+55.1122222222',
    'email' => '[e-mail]'
]);
var_dump($return->getResponse());

Buscando informações de um contato

$eppClient = EppClient::factory('user', 'password');
$contact = ResourceFactory::factory($eppClient, 'contact', ['id' => 'contact-id']);
$return = $contact->info();
var_dump($return->getResponse());

Criando uma organização

$eppClient = EppClient::factory('user', 'password');
$organization = ResourceFactory::factory($eppClient, 'organization');
$return = $organization->create([
    'id' => '246.838.523-30',
    'name' => 'José da Silva',
    'street_1' => 'Rua das Figueiras',
    'street_2' => '200',
    'city' => 'São Paulo',
    'state' => 'SP',
    'zipcode' => '01311-100',
    'country' => 'BR',
    'phone' => '+55.1133333333',
    'email' => '[e-mail]',
    'contact_admin_id' => 'JOSIL44',
    'contact_tech_id' => 'JOSIL44',
    'contact_billing_id' => 'JOSIL44',
    'contact_name' => 'José da Silva'
]);
var_dump($return->getResponse());

Buscando informações de uma organização

$eppClient = EppClient::factory('user', 'password');
$organization = ResourceFactory::factory($eppClient, 'organization', ['id' => 'JOSIL44']);
$return = $organization->info();
var_dump($return->getResponse());

Registrando um domínio

$eppClient = EppClient::factory('user', 'password');
$domain = ResourceFactory::factory($eppClient, 'domain');
$return = $domain->create([
    'name' => 'dominiodeexemplo.com.br',
    'period' => 1,
    'dns_1' => 'ns1.yoursite-idc.net',
    'dns_2' => 'ns2.yoursite-idc.net',
    'org_id' => '246.838.523-30',
    'auto_renew' => 0
]);
var_dump($return->getResponse());

Atualizando um domínio

$eppClient = EppClient::factory('user', 'password');
$domain = ResourceFactory::factory($eppClient, 'domain');
$return = $domain->update([
    'name' => 'dominiodeexemplo.com.br',
    'period' => 1,
    'dns_1' => 'ns1.yoursite-idc.net',
    'dns_2' => 'ns2.yoursite-idc.net',
    'org_id' => '246.838.523-30',
    'auto_renew' => 0
]);
var_dump($return->getResponse());

Removendo um domínio

$eppClient = EppClient::factory('user', 'password');
$domain = ResourceFactory::factory($eppClient, 'domain');
$return = $domain->delete(['name' => 'dominiodeexemplo.com.br']);
var_dump($return->getResponse());

Renovando um domínio

$eppClient = EppClient::factory('user', 'password');
$domain = ResourceFactory::factory($eppClient, 'domain');
$return = $domain->renew([
    'name' => 'dominiodeexemplo.com.br',
    'current_expiration_date' => '2000-04-03',
    'period' => 1
]);
var_dump($return->getResponse());

Obs: O parâmetro current_expiration_date é o domain:crDate de retorno do comando de domain_info.

Buscando informações de um domínio

$eppClient = EppClient::factory('user', 'password');
$domain = ResourceFactory::factory($eppClient, 'domain');
$return = $domain->info(['name' => 'yoursite6.com.br', 'ticket_number' => '']);
var_dump($return->getResponse());

Verificando se um domínio está disponível

$eppClient = EppClient::factory('user', 'password');
$domain = ResourceFactory::factory($eppClient, 'domain');
$return = $domain->check(['name' => 'yoursite6.com.br']);
var_dump($return->getResponse());

Recebendo o retorno de uma mensagem na Poll

$eppClient = EppClient::factory('user', 'password');
$poll = ResourceFactory::factory($eppClient, 'poll');
$return = $poll->request();
var_dump($return->getResponse());

Removendo uma mensagem da Poll

$eppClient = EppClient::factory('user', 'password');
$poll = ResourceFactory::factory($eppClient, 'poll');
$return = $poll->delete('<message-id>');
var_dump($return->getResponse());