Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reiterus/informer-magento
Get information about your Magento 2 store using GET requests to REST API endpoints.
https://github.com/reiterus/informer-magento
magento magento-extension magento-module magento2 magento2-extension magento2-module reiterus
Last synced: 24 days ago
JSON representation
Get information about your Magento 2 store using GET requests to REST API endpoints.
- Host: GitHub
- URL: https://github.com/reiterus/informer-magento
- Owner: reiterus
- License: mit
- Created: 2022-07-05T07:32:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-16T13:49:02.000Z (over 2 years ago)
- Last Synced: 2024-05-09T10:02:43.087Z (6 months ago)
- Topics: magento, magento-extension, magento-module, magento2, magento2-extension, magento2-module, reiterus
- Language: PHP
- Homepage:
- Size: 11.7 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magento Store Information
Get information about your Magento 2 store using GET requests to REST API endpoints.
The module is developed for Magento version **2.4.3**
# Usage
### Endpoints
- basic info: `/rest/V1/reiterus/informer`
- detail info: `/rest/V1/reiterus/informer/detail`
### Responses
Basic information for an anonymous user
```json
{
"version": "2.4.3",
"locale": "en_US",
"timezone": "America\/Chicago",
"currency": "USD"
}
```
The list of detailed information is formed at your discretion, it may look like this.
```json
[
{
"lifetime_sales": "29.00",
"average_order": "14.50",
"orders_number": "2",
"customers_number": "1",
"admins_number": "3",
"extended_data": "from main application"
}
]
```
### Set detail info
To generate a set of extended data for detailed information,
you can use the plugin from the "[example](example/Plugin/InformerBefore.php)" directory.
Don't forget to include the following information in your `di.xml` file.
```xml
```
### Endpoint testing
To check the functionality of endpoints via PhpStorm, you can use files from the request directory:
- base.http: get minimal base information
- detail.http: get detailed information you need
- token.http: get admin token
See more in the "[request](request)" folder.
# Installation
You can install the package in two ways
From packagist.org
```shell
composer require reiterus/informer-magento
```
From GitHub repository
```json
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/reiterus/informer-magento.git"
}
]
}
```
# License
This library is released under the [MIT license](LICENSE).