rafique/module-adminapi

A simple module to GET and SET admin configuration values using Magento API

dev-master 2020-05-14 08:44 UTC

proprietary

• VYCEVERSA

README

rafique/module-adminapi

• Main Functionalities
• Installation
• Configuration
• Specifications
• Attributes

Main Functionalities

A simple module to GET and SET admin configuration values using Magento API

Installation

* = in production please use the --keep-generated option

Type 1: Zip file

• Clone or download from github: https://github.com/Daniel-Rafique/rafique-module-adminapi
• Unzip the zip file in app/code/Rafique
• Enable the module by running php bin/magento module:enable Rafique_AdminApi
• Apply database updates by running php bin/magento setup:upgrade*
• Flush the cache by running php bin/magento cache:flush

Type 2: Composer

• Make the module available in a composer repository for example:
  • public repository https://packagist.org/packages/rafique/module-adminapi
  • public github repository as vcs
• Install the module composer by running composer require rafique/module-adminapi
• enable the module by running php bin/magento module:enable Rafique_AdminApi
• apply database updates by running php bin/magento setup:upgrade*
• Flush the cache by running php bin/magento cache:flush

Configuration

No Admin UI

Specifications

• API Endpoint

  • GET - Rafique\AdminApi\Api\GetValueManagementInterface > Rafique\AdminApi\Model\GetValueManagement - Make a GET request and pass in the store code and path of config value you want to retrieve.

• API Endpoint

  • PUT - Rafique\AdminApi\Api\SetValueManagementInterface > Rafique\AdminApi\Model\SetValueManagement Make a POST request with an array in raw format.

       {
       	"param": {"path":"web/seo/use_rewrites", "value":"1", "scope":"default", "encrypt":true}
       }
    

• Helper

  • Rafique\AdminApi\Helper\Data

• Configuration Type

  • api

Attributes