PHPackages                             compufacil/api-sdk - 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. compufacil/api-sdk

AbandonedArchivedLibrary[API Development](/categories/api)

compufacil/api-sdk
==================

Compufácil SDK for PHP

0.0.3(8y ago)118Compufacil PlatformPHPPHP ^7.0

Since May 23Pushed 8y agoCompare

[ Source](https://github.com/compufour/sdk-api-php)[ Packagist](https://packagist.org/packages/compufacil/api-sdk)[ Docs](https://github.com/compufour/sdk-api-php)[ RSS](/packages/compufacil-api-sdk/feed)WikiDiscussions master Synced 2d ago

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

Instalação SDK
==============

[](#instalação-sdk)

O Compufácil PHP SDK tem como dependência de instalação o `composer`. Execute o seguinte comando:

```
composer require compufacil/api-sdk

```

Integrando a API da CompuFácil via SDK PHP
==========================================

[](#integrando-a-api-da-compufácil-via-sdk-php)

A API da CompuFácil segue o padrão RPC. E o tráfego de dados é através de JSON.

Ambientes
---------

[](#ambientes)

Existem dois ambiente servindo a API. O ambiente de homologação e de produção.

- **Produção**:
- **Homologação**:

Padrão dos serviços
-------------------

[](#padrão-dos-serviços)

Todos os serviços seguem a seguinte nomenclatura:

```
$AMBIENTE/rpc/v1/$MODULO.$SERVICO
```

Módulo e serviço variam de acordo com o que parte do sistema está sendo utilizada.

### Exemplo:

[](#exemplo)

```
#listar nfe's
https://homolog.compufacil.com.br/rpc/v1/fiscal.get-nfe
#criar nfe
https://homolog.compufacil.com.br/rpc/v1/fiscal.post-nfe
#atualizar nfe
https://homolog.compufacil.com.br/rpc/v1/fiscal.put-nfe
#deletar nfe
https://homolog.compufacil.com.br/rpc/v1/fiscal.delete-nfe
```

Autenticação
------------

[](#autenticação)

Primeiramente instanciamos a classe passando as configurações do ambiente e a versão, se caso não passarmos ela pegara os valores default que sempre será ambiente de `homolog` e a última versão estável da API.

seguindo a autenticação se dá através da função `signUp`:

```
$cf = new Compufacil([
    'environment' => 'homolog',
    'version' => '1'
]);

$result = $cf->signIn('test@sdk.com', '123456');
print_r($result);
```

Na resposta de uma autenticação com sucesso conterá o token que dever ser trafegado nas requisições autenticadas.

```
{
    "status": 1,
    "access_token": "1be2b89c92aff78f9ffae8b408d80b2c2d8bcf0a",
    "default_lang": "pt_BR",
    "is_admin": true
}
```

Enquanto mantivermos a classe o token ficara armazenado no estado da mesma

Serviços
--------

[](#serviços)

Os demais serviços seguem o mesmo padrão da autenticação, com a única diferença que trafegam o token no header *Authorization-Compufacil*e utilizamos agora a função auxiliar `rpcService`

### Exemplo fazendo o CRUD de receitas

[](#exemplo-fazendo-o-crud-de-receitas)

**Lista receitas**

```
$revenues = $cf->rpcService('finance.get-revenue');
print_r($revenues); // []
```

**Cria receita**

```
$revenue = $cf->rpcService(
    'finance.post-revenue',
    [
        'description' => 'teste teste',
        'value' => 666
    ]
);
print_r($revenue); // ['id' => 152611]
```

**Pega 1 receita detalhada**

```
$revenue = $cf->rpcService(
    'finance.get-revenue',
    [
        'id' => $revenue['íd']
    ]
);
print_r($revenue); // ['id' => 152611, 'description' => 'test...]
```

**Atualiza uma receita**

```
$revenue = $cf->rpcService(
    'finance.put-revenue',
    [
        'id' => $revenue['id'],
        'description' => 'teste update',
        'value' => 999
    ]
);
print_r($revenue); // ['id' => 152611]
```

**Deleta receita**

```
$revenue = $cf->rpcService(
    'finance.delete-revenue',
    [
        'id' => $revenue['íd']
    ]
);
print_r($revenue); // ['id' => 152611]
```

Swagger
-------

[](#swagger)

Para uma referência completa dos serviços você pode consultar [o nosso swager](http://developer.compufacil.com.br/api). Lá também é possível executar os serviços diretamente contra homolog.

[Nosso blog](https://techblog.compufacil.com.br/)

Contato
-------

[](#contato)

Qualquer dúvida sobre a API entre em contato com nosso time técnico. Através do e-mail .

###  Health Score

22

—

LowBetter than 21% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

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 ~84 days

Total

2

Last Release

3241d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f5cd2cdabf326d8af0039f3f797b46965310f9cceab664ececd8b2d30ab734a4?d=identicon)[eminetto](/maintainers/eminetto)

---

Tags

sdkcompufacil

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/compufacil-api-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/compufacil-api-sdk/health.svg)](https://phpackages.com/packages/compufacil-api-sdk)
```

###  Alternatives

[appwilio/cdek-sdk

CDEK API SDK (cdek.ru)

406.5k](/packages/appwilio-cdek-sdk)[mocking-magician/coinbase-pro-sdk

Library for coinbase pro API calls

223.2k](/packages/mocking-magician-coinbase-pro-sdk)

PHPackages © 2026

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