brennersousa/cafeapi

FSPHP SaaS webservice 集成 API 库

1.0.0 2021-02-16 22:31 UTC

This package is auto-updated.

Last update: 2024-09-17 07:18:12 UTC


README

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

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

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

您可以通过点击此处了解更多信息 这里

亮点

  • 简单安装
  • 所有 API 方法的抽象
  • 使用登录和密码轻松认证
  • Composer 就绪且符合 PSR-2 规范

安装

通过 Composer 获取 Uploader

"brennersousa/cafeapi": "^1.0"

或运行

composer require brennersousa/cafeapi

文档

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

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

用户端点

<?php

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

use BrennerSousa\CafeApi\Me;

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

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

//update
$user->update([
    "first_name" => "Robson",
    "last_name" => "Leite",
    "genre" => "male",
    "datebirth" => "1980-01-02",
    "document" => "888888888"
]);

//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 BrennerSousa\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

支持

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

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

谢谢

致谢

许可证

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