iaematt/cafeapi

FSPHP SaaS Web服务集成的API库

1.0.0 2021-09-20 00:07 UTC

This package is auto-updated.

Last update: 2024-09-20 06:34:44 UTC


README

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

CaféApi库是一个小型类集,由UpInside的Full Stack PHP开发者培训课程开发,用于集成课程中开发的SaaS平台Web服务。

CaféApi库是一个小型类集,由UpInside的Full Stack PHP开发者培训课程开发,用于集成课程中开发的SaaS平台Web服务。

亮点

  • 简单安装
  • 抽象所有API方法
  • 使用电子邮件和密码轻松认证
  • 适用于composer且兼容PSR-2

安装

通过composer进行安装

"iaematt/cafeapi": "^1.0"

或运行

composer require iaematt/cafeapi

文档

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

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

用户端点

<?php

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

use iaematt\CafeApi\Me;

$me = new Me('api.site.com', 'nome@servidor.com.br', '123@mudar');

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

/** Update */
$user->update([
    'first_name' => 'Robson',
    'last_name' => 'Leite',
    'genre' => 'male',
    'date_birth' => '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 RobsonVLeite\CafeApi\Invoices;

$invoices = new Invoices('api.site.com', 'nome@servidor.com.br', '123@mudar');

/** 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

支持

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

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

感谢

致谢

许可证

MIT许可证(MIT)。请参阅 许可证文件 以获取更多信息。