README

API-клиент приложение "ДисконтКлуб Сертификаты"

Клиент для использования API приложения "ДисконтКлуб Сертификаты" для сторонних систем.
Report Bug · Request Feature

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact

About The Project

Библиотека предоставляет доступ к API приложения "ДисконтКлуб Сертификаты".

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Используется библиотека HTTPlug согласно https://docs.php-http.org/en/latest/httplug/users.html.

Installation

Рекомендованный способ установки с помощью Composer:

$ composer require softc/evotor-certificates

(back to top)

Usage

<?php

require 'vendor/autoload.php';

use SoftC\Evotor\Certificates\Api\Domain\CertificateActivate;
use SoftC\Evotor\Certificates\Api\Domain\CertificateCreate;
use SoftC\Evotor\Certificates\Api\Domain\CertificatePay;
use SoftC\Evotor\Certificates\Api\Entities\CertificateType;
use SoftC\Evotor\Certificates\Api\Enums\EntityStatus;
use SoftC\Evotor\Certificates\Api\Requests\CertificatesActivateRequest;
use SoftC\Evotor\Certificates\Api\Requests\CertificatesCreateRequest;
use SoftC\Evotor\Certificates\Api\Requests\CertificatesPayRequest;

$token = 'api-token';
$client = new Client($token);

// получить виды сертификатов
$types = $client->SelectTypes();
// оставляем только активные виды сертификатов с указанным номиналом
$types = array_filter($types, static fn(CertificateType $item) => $item->status === EntityStatus::ACTIVE && $item->value > 0);

// используем первый вид
$type = $types[0];

// создаем сертификат с произвольным номером
$number = bin2hex(random_bytes(16));
$certs = $client->CreateCertificates(new CertificatesCreateRequest([
    new CertificateCreate($number, $type->uuid)
]));

// получаем ИД созданного сертификата
$uuid = $certs[0];

// также можно найти сертификат по номеру
// $cert = $client->GetCertificateByNumber($number);

// активируем сертификат
$client->ActivateCertificates(new CertificatesActivateRequest(
    bin2hex(random_bytes(18)),
    [
        new CertificateActivate($uuid, $type->uuid)
    ]
));

// гасим сертификат
$client->PayCertificates(new CertificatesPayRequest(
    bin2hex(random_bytes(18)),
    [
        new CertificatePay($uuid, $type->value ?? 0)
    ]
));

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!