README

Compufácil PHP SDK需要通过composer安装。请执行以下命令

composer require compufacil/api-sdk

通过SDK PHP集成CompuFácil API

CompuFácil API遵循RPC标准。数据传输通过JSON进行。

环境

有两个环境提供API服务。测试环境和生产环境。

• 生产: https://app.compufacil.com.br
• 测试: https://homolog.compufacil.com.br

服务标准

所有服务遵循以下命名规范

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

模块和服务根据所使用的系统部分而有所不同。

示例

#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

认证

首先实例化类，传入环境配置和版本，如果不传入，它将获取默认值，总是为homolog环境和API的最后一个稳定版本。

认证通过signUp函数进行

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

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

成功的认证响应将包含应通过认证请求传输的token。

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

只要我们保持类，token就会存储在类的状态中

服务

其他服务遵循与认证相同的模式，唯一的区别是将token通过Authorization-Compufacil头传输，并使用辅助函数rpcService

示例：执行食谱的CRUD操作

列出食谱

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

创建食谱

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

获取一个详细的食谱

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

更新食谱

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

删除食谱

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

Swagger

要查看服务的完整参考，您可以查阅我们的Swagger。在那里您还可以直接对测试环境执行服务。

我们的博客

联系

有关API的任何疑问，请联系我们的技术团队。通过电子邮件contato@compufacil.com.br。