aldemirsouza/cafeapi

Biblioteca API para integração com o webservice do SaaS FSPHP

1.0.0 2019-07-19 02:36 UTC

This package is auto-updated.

Last update: 2024-09-18 07:31:04 UTC


README

Maintainer Source Code PHP from Packagist Latest Version Software License Build Quality Score Total Downloads

CaféApi 库是一组小类,由 UpInside 的 Full Stack PHP 开发者培训开发,用于集成到课程中开发的 SaaS 平台 webservice 中。

CaféApi 库是一组小类,由 Full Stack PHP 开发者培训开发,用于集成到 SaaS 平台的 webservice 中。

您可以通过 这里 获取更多信息。

亮点

  • 简单安装
  • 抽象所有 API 方法
  • 登录和密码简单认证
  • 准备就绪的 Composer 和 PSR-2 兼容

安装

通过 Composer 提供

"aldemirsouza/cafeapi": "^1.0"

或运行

composer require aldemirsouza/cafeapi

文档

有关使用方法的详细信息,请参阅组件目录中的示例文件夹。其中包含每个类的使用示例。它的工作方式如下

有关如何使用的更多详细信息,请参阅组件目录中的示例文件夹。其中包含每个类的使用示例。它的工作方式如下

用户端点

<?php

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

use AldemirSouza\CafeApi\Me;

$me = new Me(
    "suaapi.url.com",
    "seu@email.com.br",
    "suasenha"
);

//me
$user = $me->me();

//update
$user->update([
    "first_name" => "Aldemir",
    "last_name" => "Souza",
    "genre" => "male",
    "datebirth" => "1987-19-06",
    "document" => "999999999"
]);

//photo
$user->photo($_FILES["photo"]);

//test and result
if ($user->error()) {
    $user->error(); //object
} else {
    $user->response(); //object
}

发票端点

<?php

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

use RobsonVLeite\CafeApi\Invoices;

$invoices = new Invoices(
    "suaapi.url.com",
    "seu@email.com.br",
    "suasenha"
);

//index
$index = $invoices->index(null);

//index filter
$index = $invoices->index([
    "wallet_id" => 23,
    "type" => "fixed_income",
    "status" => "paid",
    "page" => 2
]);

//create
$invoices->create([
    "wallet_id" => 23,
    "category_id" => 3,
    "description" => "Pagamento Cartão",
    "type" => "expense",
    "value" => "25000.20",
    "due_at" => "2019-10-02",
    "repeat_when" => "single",
    "period" => "month",
    "enrollments" => "1",
]);

//read
$invoices->read(91);

//update
$invoiceId = 91;
$invoices->update($invoiceId, [
    "wallet_id" => 23,
    "category_id" => 3,
    "description" => "Pagamento Cartão",
    "value" => "25000.20",
    "due_day" => 25,
    "status" => "paid"
]);

//delete
$invoices->delete(91);

//test and result
if ($invoices->error()) {
    $invoices->error(); //object
} else {
    $invoices->response(); //object
}

其他

您还有用于投资组合和签名的端点类,所有带有实际示例的使用文档都可在 examples 文件夹的库中找到。请查看。

您还有用于投资组合和签名的端点类,所有带有实际示例的使用文档都可在该库的 examples 文件夹中找到。请查看。

贡献

有关详细信息,请参阅 CONTRIBUTING

支持

安全:如果您发现任何与安全相关的问题,请通过电子邮件 aldemmir17b@gmail.com 而不是使用问题跟踪器来报告。

如果您发现任何与安全相关的问题,请通过电子邮件 aldemmir17b@gmail.com 而不是使用问题跟踪器来报告。

谢谢

致谢

许可

MIT 许可证(MIT)。有关更多信息,请参阅 许可文件