Skip to main content

How to create a custom Rest API?

REST stands for representational state transfer and API stands for an application programming interface. REST API is basically used for performing some operations and getting responses based on the request using the HTTP protocol. Magento provides a huge list of REST APIs which you can check here. Another approach to check and play with the existing APIs in the Magento system is Swagger. You can access Swagger by any browser and the URL will be your website's baseUrl/swagger.

Now let's see how we can add a new custom API in Magento. Let's learn this by creating a custom API to get all the store configurations using API. 

Step - 1: Create a webApi.xml file and add the route for your API

<?xml version="1.0"?>
<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
  <route method="GET" url="/V1/custom/storeConfigurations/">
    <service class="MageInsight\Common\Api\StoreConfigurationInterface" method="getConfigs"/>
    <resources>
      <resource ref="Magento_Backend::store"/>
    </resources>
  </route>
</routes>

Here you can see, that the API endpoint will be custom/storeConfigurations and the method will be the GET method.

Step - 2: Create an Interface for your API

<?php

namespace MageInsight\Common\Api;

interface StoreConfigurationInterface
{
    /**
     * Get store configurations
     * @param string $path
     * @return string|array
     */
    public function getConfigs($path);
}

While creating an interface, take care of the below points:

  • Add the method name here with the same name declared in the webApi.xml file.
  • Add proper comments for the function, because that defines the parameter & response datatype. And method description will be shown in the swagger.
Step - 3: Add preference for the interface

<?xml version="1.0"?>

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/ObjectManager/etc/config.xsd">
    <preference for="MageInsight\Common\Api\StoreConfigurationInterface" type="MageInsight\Common\Model\StoreConfiguration"/>
</config>

Step - 4: Create a model which will have the definition of the method declared in the interface

<?php

namespace MageInsight\Common\Model;

use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\Controller\Result\JsonFactory;
use function Safe\json_encode;

class StoreConfiguration
{
    protected $scopeConfig;

    protected $jsonFactory;

    public function __construct(
        ScopeConfigInterface $scopeConfig,
        JsonFactory $jsonFactory
    ){
        $this->scopeConfig = $scopeConfig;
        $this->jsonFactory = $jsonFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfigs($path) {
        $config = $this->scopeConfig->getValue($path, \Magento\Store\Model\ScopeInterface::SCOPE_STORES, 0);
        if (is_string($config)) {
            $result[] = ["value" => (int) $config];
            return $result;
        }

        return [$config];
    }
}

After this, the API can be tested using swagger or postman.

Comments

Popular posts from this blog

Unlocking Success: The Vital Role of the Contact Us Page in E-commerce

In the dynamic realm of e-commerce, where digital transactions reign supreme, the significance of customer communication cannot be overstated. Amidst the plethora of factors influencing the success of an online store, one often overlooked yet fundamentally important element is the Contact Us page. This seemingly humble corner of a website holds immense power, serving as a linchpin in fostering trust, resolving issues, and nurturing customer relationships. Let's delve deeper into why the Contact Us page is not just an afterthought but a strategic asset for e-commerce businesses, backed by proven data. Building Trust and Credibility Trust is the cornerstone of any successful e-commerce venture. According to a survey conducted by Edelman, 81% of consumers say that trusting a brand to do what is right is a deciding factor in their purchasing decisions. A prominently displayed Contact Us page with clear contact information, including a physical address, phone number, and email address, ...

Magento - LogRocket Integration

In today’s competitive eCommerce landscape, understanding user behavior is crucial for optimizing customer experiences and improving conversion rates. Magento 2, a powerful and flexible eCommerce platform, allows merchants to customize their online stores extensively. However, monitoring how users interact with these customizations is often challenging. This is where LogRocket, a modern session replay tool, comes into play. Integrating LogRocket with Magento 2 can provide invaluable insights into user behavior, performance bottlenecks, and UX issues. In this blog post, we’ll walk you through the steps to integrate LogRocket with Magento 2, and how this integration can help you improve your store’s performance and user experience. What is LogRocket? LogRocket is a session replay tool that enables you to record and playback user activity on your website. It tracks interactions such as clicks, scrolls, and form inputs, giving you a clear view of how users navigate your store. In addition,...

Magento 2: How to enable cache for a custom EAV attributes?

To prepare for the certification exam, the candidate should know about different cache types and their purpose. The cache is an important and crucial part of the website's performance. One of the caches is the "EAV types and attributes" cache. You can check the list of caches in Magento Admin and by using console commands. Below is the screenshot of the list of caches in admin under System -> Cache Management As of version 2.3.4, Commerce caches all system EAV attributes as they are retrieved. Caching EAV attributes in this manner improves performance, because it decreases the amount of insert/select requests to the DB. However, it increases cache network size as well. Developers can cache custom EAV attributes by running the below command. bin/magento config:set dev/caching/cache_user_defined_attributes 1 This can also be done from the Admin while in Developer mode by setting Stores > Settings Configuration > Advanced > Developer > Caching Settings > Ca...