jcolombo/paymo-api-php

PHP 实现的 Paymo 应用 API

v0.5.3 2023-12-07 18:58 UTC

This package is auto-updated.

Last update: 2024-09-27 17:03:46 UTC


README

#PaymoApp API for PHP 一个强大的 PHP 实现 Paymo 应用 API

PaymoApp (www.paymoapp.com) 是一个功能强大的项目管理平台,它提供了一个 API,允许程序员通过一系列 RESTful 端点完全操作其账户。这个独立开发的软件包创建了一个针对程序员的友好工具包,简化了与应用程序的所有交互,并且与 Paymo 公司或品牌无关。

官方发布的 REST API 文档可在此处找到

https://github.com/paymoapp/api

不稳定版本 0.5 (使用 @dev 包获取最新版本,每日更新)

此软件包不稳定,正在积极开发中,但截至 2020 年 3 月 18 日,大部分功能可用。计划在 2020 年 4 月发布 1.0.0 版本。该版本正在由 360 PSG 公司的开发团队构建和支持,并采用 MIT 许可证发布,供所有人使用。请给我们一点时间使其稳定并完成。假设在 1.0.0 版本发布之前,任何内容都可能因为破坏性更新而发生变化。

软件包功能

  • 为所有 Paymo 对象提供面向对象的获取、创建、更新和删除类
  • [部分] 严格类型检查以确保每个对象类型使用正确的数据类型
  • 单次调用即可选择深层次的关系
  • 轻松上传和附加本地图像文件,用于具有图像的对象(客户标志、用户等)
  • 能够通过自己的扩展扩展和覆盖软件包对象
  • [待办事项] 本地文件缓存,以避免对 API 的不必要的重复调用(有助于避免速率限制)
  • [待办事项] 深度日志工具,用于集成和开发期间的调试

要求

  • 有效的 PaymoApp 账户 (www.paymoapp.com)
  • PHP 7.1 或更高版本
  • Composer(易于安装)或安装此源代码的能力

安装

paymo-api-php 软件包通过 composer 直接从 Packagist 安装效果最佳


composer require jcolombo/paymo-api-php

入门

use Jcolombo\PaymoApiPhp\Paymo;
use Jcolombo\PaymoApiPhp\Entity\Resource\Project;

// Start a connection with the Paymo API
$paymo = Paymo::connect('YOUR_API_KEY');

// Load a specific project by its ID
$project = new Project();
$project -> fetch(12345);
// OR
$project = Project::new()->fetch(12345);
// $project is now fully populated with the data from the matching Paymo project

// Load a project with all the client details attached to it
$project -> fetch(12345, ['client']);
// OR
$project = Project::new()->fetch(12345, ['client']);

// Load a list of all projects the API key can see
$projects = Project::list()->fetch();

// Creating a new Project
$project = new Project();
$project -> name = "My Fake Project";
$project -> create();
// $project exists now in paymo, object is populated with full project data from response
// Alternative create with chaining

$project = Project::new()->set(['name'=>'My Fake Project'])->create();