PHPackages                             vitorccs/procob-api-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. vitorccs/procob-api-php

ActiveLibrary[API Development](/categories/api)

vitorccs/procob-api-php
=======================

SDK PHP para a API da Procob S/A

v1.1.0(4y ago)1631[2 PRs](https://github.com/vitorccs/procob-api-php/pulls)GPL-3.0PHPPHP >=7.1

Since Oct 30Pushed 3y ago1 watchersCompare

[ Source](https://github.com/vitorccs/procob-api-php)[ Packagist](https://packagist.org/packages/vitorccs/procob-api-php)[ Docs](https://github.com/vitorccs/procob-api-php)[ RSS](/packages/vitorccs-procob-api-php/feed)WikiDiscussions master Synced 6d ago

READMEChangelog (1)Dependencies (3)Versions (9)Used By (0)

Procob API - SDK PHP
====================

[](#procob-api---sdk-php)

SDK em PHP para consulta a API RESTful da Procob S.A.

Descrição
---------

[](#descrição)

SDK em PHP para consulta a API RESTful da Procob S.A. [Documentação da API da Procob S/A](https://api.procob.com/)

Instalação
----------

[](#instalação)

Via Composer

```
composer require vitorccs/procob-api-php
```

Parâmetros
----------

[](#parâmetros)

ParâmetroObrigatórioPadrãoComentárioPROCOB\_API\_USERSim-Usuário da API para autenticar.PROCOB\_API\_PWDSim-Senha da API para autenticar. Se omitido, será usuado o de teste.PROCOB\_API\_TIMEOUTNão30Timeout em segundos para estabelecer conexão com a APIComo usar
---------

[](#como-usar)

1. Os parâmetros podem ser definidos por váriaveis de ambiente:

```
putenv('PROCOB_API_USER=sandbox@procob.com');
putenv('PROCOB_API_PWD=TesteApi');
putenv('PROCOB_API_TIMEOUT=30');
```

ou passados por `array`:

```
\Procob\Http\Procob::setParams([
    'PROCOB_API_USER' => 'sandbox@procob.com',
    'PROCOB_API_PWD' => 'TesteApi',
    'PROCOB_API_TIMEOUT' => 30
]);
```

2. Em seguida, basta utilizar qualquer um dos métodos disponíveís:

```
$consulta = \Procob\Person::getByCpfCnpj($cpfCnpj);
```

Você poderá usar o usuário e senha de testes da Procob ( | TesteApi), porém, os dados retornados pela API são todos fictícios

Métodos disponíveis
-------------------

[](#métodos-disponíveis)

```
// CPF/CNPJ Completo
Procob\Person::getByCpfCnpj($cpfCnpj)

// CPF/CNPJ pelo Nome
Procob\Person::getByName($cpfCnpj, $params = [])

// DDD + Telefone
Procob\Person::getByPhone($ddd, $number)

// Sintegra
Procob\Person::getCpfCnpjStatus($cpfCnpj, $params = [])

// Quadro Societário / Participação em Empresa(s)
Procob\Person::getCompanyPartners($cnpj)

// Vizinhos
Procob\Person::getNeighbors($params)

// CPF/CNPJ pelo E-mail
Procob\Person::getByEmail($email)

// Número do Benefício
Procob\Person::getNationalInsuranceStatus($cpf)

// Dados Gerais
Procob\Person::getBasicData($cpfCnpj)

// Perfil CNPJ
Procob\Person::getCompanyProfile($cnpj)
```

Normalização de dados
---------------------

[](#normalização-de-dados)

- Os dados de CPF e CNPJ podem ser passados no formato número ou texto, com ou sem máscaras.
- Os números de CPF e CNPJ sempre passam por validação de dados da própria SDK, evitando com isso consumir uma requisição a API.
- A SDK reconhece automaticamente quando a API da Procob não teve sucesso (código diferente de "000") e nestes casos, lança uma "exceção" (Exception) com a mensagem de erro.

Exemplo de implementação
------------------------

[](#exemplo-de-implementação)

```
use Procob\Exceptions\ProcobApiException;
use Procob\Exceptions\ProcobRequestException;

error_reporting(E_ALL);
ini_set('display_errors', 1);

require __DIR__ . '/vendor/autoload.php';

putenv('PROCOB_API_TIMEOUT=30');
putenv('PROCOB_API_USER=sandbox@procob.com');
putenv('PROCOB_API_PWD=TesteApi');

try {
    $response = Procob\Person::getByCpfCnpj('06.116.543/0001-55');
    print_r($response);
} catch (ProcobApiException $e) { // erros retornados pela API Procob
    echo sprintf("%s (%s)", $e->getMessage(), $e->getErrorCode());
} catch (ProcobRequestException $e) { // erros de servidor (erros HTTP 4xx e 5xx)
    echo sprintf("%s (%s)", $e->getMessage(), $e->getErrorCode());
} catch (\Exception $e) { // demais erros
    echo $e->getMessage();
}
```

Testes
------

[](#testes)

Caso queira contribuir, por favor, implementar testes de unidade em PHPUnit.

Para executar:

```
composer test
```

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~214 days

Recently: every ~268 days

Total

6

Last Release

1683d ago

PHP version history (2 changes)v1.0PHP >=7.0.0

v1.1.0PHP >=7.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/2d5d2e771a97ac9dc5a1a1c8a18ec3cf97b5ea7872bfbc0fd62b060545cf6dfa?d=identicon)[vitorccs](/maintainers/vitorccs)

---

Top Contributors

[![vitorccs](https://avatars.githubusercontent.com/u/9891961?v=4)](https://github.com/vitorccs "vitorccs (19 commits)")

---

Tags

procob

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/vitorccs-procob-api-php/health.svg)

```
[![Health](https://phpackages.com/badges/vitorccs-procob-api-php/health.svg)](https://phpackages.com/packages/vitorccs-procob-api-php)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)