simplia/api

There is no license information available for the latest version (0.1.19) of this package.

0.1.19 2024-10-08 07:41 UTC

Requires

• php: >=7.4
• ext-json: *
• nyholm/psr7: ^1.4
• psr/http-client: ^1.0

Unknown License

• Petr Soukup

README

SDK pro API eshopů Simplia.cz (https://api.simplia.cz/) určené pro interní napojení. Automaticky generováno z OpenAPI definic.

Výhody oproti přímému použití REST API:

• možnost statické analýzy (PHPStan) a odladění problému bez nutnosti volat API
• jednodušší testování (komunikace s SDK se mockuje jednodušeji než celá HTTP komunikace)
• napovídání v editoru

Installing

composer require simplia/api:dev-master

Contributing

Celý repozitář je automaticky generován z OpenAPI definic a pull request je potřeba poslat pro generátoru (nebo jen popsat problém v issue zde)

Terminology

• ___Endpoint - kategorie operací
• ___Request - parametry výpisu jako je řazení, filtry, ...
• ___FieldConfig - seznam polí, které se mají získat z backendu
• ___Input - vstup pro operaci jako například nový popis produktu apod, který se pošle jako tělo API požadavku

Examples

Create new order

use \Simplia\Api\Api;
use \Simplia\Api\Input\AddressTypeApiInput;
use \Simplia\Api\Input\OrderCreateTypeApiInput;
use \Simplia\Api\Input\OrderItemTypeApiInput;
use \Simplia\Api\Entity\OrderApiEntity;

$api = Api::withUsernameAuth($httpClient, 'demo2.simpliashop.cz', 'api_user', '*********');
$order = $api->getOrdersEndpoint()->create(
    OrderCreateTypeApiInput::create()
        ->setDeliveryAddress(
            AddressTypeApiInput::create()
                ->setFirstName('John')
                ->setLastName('Smith')
                ->setCity('Prague')
                ->setEmail('[e-mail]')
        )
        ->setCustomerNote('customer note')
        ->setItems([
            OrderItemTypeApiInput::create()
            ->setItemId(123)
            ->setQuantity(2)
            ->setPriceVat(200) // unit price with vat
        ]),
    OrderApiEntity::createFieldConfig()
        ->withId()
);

echo $order->getId();

Change order status

use \Simplia\Api\Api;
use \Simplia\Api\Input\OrderStatusTypeApiInput;

$api = Api::withUsernameAuth($httpClient, 'demo2.simpliashop.cz', 'api_user', '*********');
$api->getOrdersEndpoint()->updateStatus(
    '123',
    OrderStatusTypeApiInput::create()
        ->setStatusId(4)
);

List orders from status by name

use \Simplia\Api\Api;
use \Simplia\Api\Entity\ContactApiEntity;
use \Simplia\Api\Entity\OrderApiEntity;
use \Simplia\Api\Request\OrderApiRequest;

$api = Api::withUsernameAuth($httpClient, 'demo2.simpliashop.cz', 'api_user', '*********');
$orders = $api->getOrdersEndpoint()->iterate(
    OrderApiRequest::create()
        ->whereStatus(1),
    OrderApiEntity::createFieldConfig()
        ->withId()
        ->withDeliveryAddress(
            ContactApiEntity::createFieldConfig()
                ->withCompanyName()
        )
);

foreach ($orders as $order) {
    echo $order->getId();
    echo $order->getDeliveryAddress()->getCompanyName();
}

Get single order

use \Simplia\Api\Api;
use \Simplia\Api\Entity\ContactApiEntity;
use \Simplia\Api\Entity\OrderApiEntity;

$api = Api::withUsernameAuth($httpClient, 'demo2.simpliashop.cz', 'api_user', '*********');
$order = $api->getOrdersEndpoint()->get(
   '123',
    OrderApiEntity::createFieldConfig()
        ->withId()
        ->withDeliveryAddress(
            ContactApiEntity::createFieldConfig()
                ->withCompanyName()
        )
);

echo $order->getId();
echo $order->getDeliveryAddress()->getCompanyName();
echo $order->getCurrency(); // throws error because currency with wasn't loaded from API (is not defined in field config)

Article list by topic

use \Simplia\Api\Api;
use \Simplia\Api\Request\ArticleApiRequest;
use \Simplia\Api\Entity\ArticleApiEntity;

$api = Api::withUsernameAuth($httpClient, 'demo2.simpliashop.cz', 'api_user', '*********');
$articles = $api->getArticlesEndpoint()->iterate(
    ArticleApiRequest::create()
        ->whereTopic(7)
        ->orderByPublishedAsc(),
    ArticleApiEntity::createFieldConfig()
        ->withName()
        ->withUrl()
);

foreach ($articles as $article) {
    echo '<a href="' . $article->getUrl() . '">' . $article->getName() . '</a>';
}