I am trying to integrate my external API in my magento 2.4.6 instance.
I Used Guzzlehttp to make and fetch the data and handle the request.
The problem is, I have to provide Username & password to the token endpoint and fetch the Access token.
Later I can provide that token to access further resources.
My question is, I want to store the Access token somewhere, that I dont want to regenerate for each call. Where can I store it?
or else any other mechanisms are expected.
In Magento 2, you can use the built-in functionality to store and retrieve custom configuration values. This is a good place to store your API access token. Here's how you can do it:
<!-- File: app/code/Vendor/Module/etc/adminhtml/system.xml -->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<section id="your_section">
<group id="your_group">
<field id="api_token" translate="label" type="obscure" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1">
<label>API Token</label>
<backend_model>Magento\Config\Model\Config\Backend\Encrypted</backend_model>
</field>
</group>
</section>
</system>
</config>
Now you can set the API token in the Magento admin panel under Stores > Configuration > Your Section > Your Group > API Token.
To retrieve the API token in your code, you can use the ScopeConfigInterface:
<?php
namespace Vendor\Module\Model;
class YourClass
{
protected $scopeConfig;
protected $encryptor;
public function __construct(
\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
\Magento\Framework\Encryption\EncryptorInterface $encryptor
) {
$this->scopeConfig = $scopeConfig;
$this->encryptor = $encryptor;
}
public function getApiToken()
{
$encryptedToken = $this->scopeConfig->getValue(
'your_section/your_group/api_token',
\Magento\Store\Model\ScopeInterface::SCOPE_STORE
);
return $this->encryptor->decrypt($encryptedToken);
}
}
Remember to replace Vendor, Module, your_section, your_group, and YourClass with your actual vendor name, module name, section ID, group ID, and class name.
Also, to set a configuration value programmatically in Magento 2,
you can use the
Magento\Framework\App\Config\Storage\WriterInterface and Magento\Framework\App\Config\ScopeConfigInterface classes.
Example:
<?php
namespace Vendor\Module\Model;
class YourClass
{
protected $configWriter;
public function __construct(
\Magento\Framework\App\Config\Storage\WriterInterface $configWriter
) {
$this->configWriter = $configWriter;
}
public function setApiToken($value)
{
$this->configWriter->save(
'your_section/your_group/api_token',
$value,
$scope = \Magento\Framework\App\Config\ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
$scopeId = 0
);
}
}
The save method takes four parameters:
the path of the configuration value, the value to save, the scope of the configuration value (default, websites, or stores), and the ID of the scope.
https://www.beehexa.com/devdocs/how-to-create-an-integration-in-magento-2/
use this solution for this, you can use the Magento back-end to create an integration manually or build a custom in Magento 2 extension to create that integration programmatically.
Steps to Get Store Config Value in Magento 2: Step 1: Create the system.xml file inside the etc folder Path – Vendor/Extension/etc/adminhtml/system.xml
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<section id="custom" translate="label" type="text" sortOrder="310" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Custom Settings</label>
<group id="custom_group_id" translate="label" type="text" sortOrder="1" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Main label</label>
<field id="custom_field_id" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
<label>Field Name</label>
</field>
</group>
</section>
</system>
</config>
Step 2: Now create Data.php file inside the Helper folder Path – Vendor/Extension/Helper/Data.php
<?php
namespace Vendor\Extension\Helper;
use Magento\Store\Model\ScopeInterface;
use Magento\Framework\App\Helper\AbstractHelper;
class Data extends AbstractHelper
{
const XML_CONFIG_PATH = 'custom/custom_group_id/custom_field_id';
public function getConfig()
{
$configValue = $this->scopeConfig->getValue(self::XML_CONFIG_PATH,ScopeInterface::SCOPE_STORE);
return $configValue;
}
}
Note – You can inject the helper class anywhere and use the getConfig() function to get the config value.This way you can Get Store Config Value in Magento 2.
@Haarish Infant Raj
Hey,
Simply once you have fetched the token than you can store that token to your custom configuration field (if not than create) (save in core_config_data table) and just fetch token from that, not needed to regenerate in every calls.
Thank You!
