macielsalzano/cafeapi

用于与FSPHP SaaS平台webservice集成的API库

1.0.0 2023-08-25 12:12 UTC

This package is not auto-updated.

Last update: 2024-09-21 16:36:32 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中。

您可以点击此处了解详细信息:clicando aqui

亮点

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

安装

通过Composer可用

"macielsalzano/cafeapi": "^1.0"

或运行

composer require macielsalzano/cafeapi

文档

有关如何使用详细信息,请参阅组件目录中的示例文件夹。在其中,您将找到每个类的使用示例。它的工作原理如下

有关如何使用详细信息,请参阅组件目录中的示例文件夹。在其中,您将找到每个类的使用示例。它的工作原理如下

用户端点

<?php

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

use MacielSalzano\CafeApi\Me;

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

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

//update
$user->update([
    "first_name" => "Maciel",
    "last_name" => "Salzano",
    "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 MacielSalzano\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)。有关更多信息,请参阅许可文件