Magento 2 : API with GET and POST

Magento 2 API are used to fetch the data and create or update data in magento.

Following is the example of creating custom api for GET and POST

In Magento 2, a module is developed with service contract design pattern, the RepositoryInterface is used for
API GET and POST to get the records and save the record respectively.

Refer the webapi.xml in the etc folder of CMS module

However, the custom API can be implemented by customizing the RepositoryInterface or creating new Interface

The new interface should be created with '@api' anotation.

Eg:


/**
 * @api
 */
interface StoneManagementInterface
{
    
    /**
     * Get Terms and Conditions.
     *
     * @return \Zend\Json\Json
     */
    public function getTermsAndConditions();

    /**
     * Get Rate list.
     *
     * @return RateSearchResultsInterface
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function getRates();
}

The first method is just return as the Json but the second method use the class that extends Magento\Framework\Api\SearchResultsInterface;
in the service contract implementation.


    /**
     * Get the term and conditions.
     *
     * @return array
     */
    public function getTermsAndConditions()
    {
        return [
            'update_at' => '2022-01-06',
            'version' => 1,
            'content' => '<h1>The terms and conditions</h1><p> The conditions </p>',
            'is_accepted' => 0
        ];
    }
    
    /**
     * @inheritdoc
     */
    public function getRates()
    {
        $params = $this->request->getParams();
        $adminId = (should be fetched from admin token)
        if (!$adminId) {
            throw new LocalizedException(__('Not authorized to get Rates. '));
        }

        return $this->rateRepository->getList($this->service->getRatesearchCriteria($adminId, $params));
    }

In the webapi.xml file

<route url="V1/bidding/termsandconditions" method="GET">
        <service class="Vasan\Bidding\Api\MilestoneManagementInterface" method="getTermsAndConditions"/>
        <resources>
            <resource ref="anonymous"/>
        </resources>
    </route>

    <route url="V1/bidding/rates" method="GET">
        <service class="Vasan\Bidding\Api\MilestoneManagementInterface" method="getRates"/>
        <resources>
            <resource ref="Vasan_Bidding::rate_get"/>
        </resources>
    </route>

vasan

Say thanks

Last edit

About 2 years ago

vasan

Magento 2 : Admin Module Part 2

5.Create Model and Resource model

Address model class extends the AddressInterface and it contains the data object getters setter methods.

<?php
/**
 * Address
 *
 * @copyright Copyright © 2021 Va...

Magento 2 : Admin Module Part 1

1. Create required folders and files for a module

Vasan
--KpsAddress
  --Api
    --Data
      --AddressInterface.php
      --AddressSearchResultsInterface.php
    --AddressRepositoryIn...

Magento 2 : Custom Email Sending

Email can be sent in magento customization with following implementation

First, The email template should be created in view section and registered in etc using email_template.xml

email_template.xml

<?xml version="1.0"?>

<config xmlns:xsi...

Magento 2 Notes

1) Non Auto Increment Primary key

The $_isPkAutoIncrement should be assigned as false in resource model, when a primary key of a table is used as non auto increment.

protected $_isPkAutoIncrement = false;

2) Custom Cron Job

F...

Magento 2: API Functional Testing

The API funcational testing can be implemented using following steps

First Step : Develop your API

Second Step : Write the API Test class

Eg:

<?php
/**
 * OrganisationRepositoryTest
 *
 * @copyright Copyright © 2023 Vasan. All rights reser...

Magento 2 : Data cleaning and import

Following example shows how to clean customer and order records and import customer data from another database

## Following query to identify the name of the attribute and attribute id
select * from  live.eav_attribute where entity_type_i...

Magento 2 : Create cron with config schedule

Step 1:

Create system.xml file with configuration field.

<group id="cron" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1"
                   showInStore="1">
                <label>MSD Cron</label>
      ...

Posted by vasan to vasan's deck (2021-09-24 12:01)

Magento 2 : API with GET and POST

Related cards:

5.Create Model and Resource model

1. Create required folders and files for a module