sun-ergo-s/darujme-na-laravel

通过API连接到Darujme.sk服务

0.0.2 2024-07-23 13:12 UTC

This package is auto-updated.

Last update: 2024-09-24 07:02:51 UTC


README

通过可用的API接口与Darujme.sk网站进行简单通信。

目前提供

活动列表
用户列表
根据ID的用户详情
将用户角色分配给组织
支付列表

... 目前仅用于个人需求,但功能可以轻松扩展。

安装

可以使用composer

composer require sun-ergo-s/darujme-na-laravel:dev-main

您还可以创建配置文件(目前仅从 .env 中提取值,但将来可以添加可变设置)

php artisan vendor:publish --tag="darujme-config"

.env 文件中,需要定义API密钥、密钥和登录信息以及组织ID

DARUJME_API_KEY=api_kluc_poskytnuty_prevadzkovatelom_darujme_sk
DARUJME_API_SECRET=secret_kluc_poskytnuty_prevadzkovatelom_darujme_sk
DARUJME_USERNAME=vase_prihlasovacie_meno_na_portal
DARUJME_PASSWORD=vase_heslo
DARUJME_ORGANIZATION_ID=id_vasej_organizacie

使用

use SunErgoS\DarujmeNaLaravel\Facades\Darujme;

$campaigns = Darujme::listOfCampaigns();

可用方法

活动列表

API文档参考

$campaigns = Darujme::listOfCampaigns();

用户列表

API文档参考

$users = Darujme::listOfUsers();

根据ID的用户详情

API文档参考

$path_vars = [
    "id" => "..."
];

$user_detail = Darujme::userDetail($path_vars);

将用户角色分配给组织

API文档参考

$path_vars = [
    "userId" => "..."
];

$body = [
    "organisations" => [
        [
            "organisation_id" => "...",
            "role" => "manager"
        ]
    ]
];

$user_detail = Darujme::addUserToOrganization($path_vars, $body);

支付列表

API文档参考

$list_of_payments = Darujme::listOfPayments();