README

Jednoduchá komunikácia s portálom Darujme.sk prostredníctvom dostupného API rozhrania.

Zatiaľ zabezpečuje:

Zoznam kampaní
Zoznam užívateľov
Detail užívateľa na základe ID
Priradenie role používateľa k organizácii
Zoznam platieb

... zatiaľ len na vlastné potreby, ale funkcionalitu je možné jednoducho rozšíriť.

Inštalácia

Môžete použiť composer:

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

Taktiež môžete vytvoriť konfiguračný súbor (zatiaľ ťahá len hodnoty z .env, ale do budúcna sa môžu pridať variabilné nastavenia):

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

V .env súbore je potrebné zadefinovať API kľúč, Secret a prihlasovacie údaje ako aj ID organizácie:

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

Použitie

use SunErgoS\DarujmeNaLaravel\Facades\Darujme;

$campaigns = Darujme::listOfCampaigns();

Dostupné metódy:

Zoznam kampaní

API doc referencia

$campaigns = Darujme::listOfCampaigns();

Zoznam užívateľov

API doc referencia

$users = Darujme::listOfUsers();

Detail užívateľa na základe ID

API doc referencia

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

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

Priradenie role používateľa k organizácii

API doc referencia

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

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

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

Zoznam platieb

API doc referencia

$list_of_payments = Darujme::listOfPayments();