如何在magento中实现自定义REST API?

时间:2013-12-19 10:16:56

标签: php rest magento

我正在尝试创建自定义REST api。 我创建了自己的模块Custom / Restapi.Custom [Namespace],Restapi [Module name]。

在etc文件夹中,我创建了config.xml和api2.xml。下面是代码 - :

的Config.xml

<?xml version="1.0"?>
<config>
    <modules>
        <Custom_Restapi>
            <version>0.1.0.0</version>
        </Custom_Restapi>
    </modules>
    <global>
        <models>
            <restapi>
                <class>Custom_Restapi_Model</class>
            </restapi>
        </models>
</config>

api2.xml

<config>
    <api2>
        <resource_groups>
            <restapi translate="title" module="Custom_Restapi">
                <title>Custom Rest API</title>
                <sort_order>10</sort_order>
            </restapi>
        </resource_groups>
        <resources>
            <restapi translate="title" module="Custom_Restapi">
                <group>restapi</group>
                <model>restapi/api2_restapi</model>
                <title>Testing My Rest API</title>
                <sort_order>10</sort_order>
                <privileges>
                    <admin>
                        <create>1</create>
                       <!-- <retrieve>1</retrieve>
                        <delete>1</delete>-->
                    </admin>
                   <!--  <customer>
                        <create>1</create>
                        <retrieve>1</retrieve>
                         <delete>1</delete>
                    </customer>
                     <guest>
                        <create>1</create>
                       <retrieve>1</retrieve>
                        <delete>1</delete>
                    </guest>-->
                </privileges>
                <routes>
                    <route_entity>
                        <route>/custom/createwebsite/:s</route>
                        <action_type>entity</action_type>
                    </route_entity>
                </routes>
                <versions>1</versions>
            </restapi>
        </resources>
    </api2>

模型目录结构

应用\代码\本地\定制\ RESTAPI \模型\ API2 \ Restapi.php。以下是文件代码 - :

Restapi.php

class Custom_Restapi_Model_Api2_Restapi extends Mage_Api2_Model_Resource
{

}

app \ code \ local \ Custom \ Restapi \ Model \ Api2 \ Restapi \ Rest \ Admin \ V1.php下面是文件代码 - :

V1.php

class Custom_Restapi_Model_Api2_Restapi_Rest_Admin_V1 extends Custom_Restapi_Model_Api2_Restapi
{
     protected function _create(){


   return  json_encode(array("testing","hello"));
}

 protected function _retrieveCollection()
{
      return  json_encode(array("testing","hello"));
 }
}

也设置了Etc /模块配置文件。

管理员设置

  1. 我创建了OAuth角色admin。在左侧选项卡“角色Api资源”模块设置可见并选中。

  2. 还配置了休息室消费者设置。

  3. 下面是REST API调用脚本代码 - :

    Api调用脚本代码

    $consumerKey    = 'ozr74egldg07dpxtkk9uq1o8bj6wwd65'; // from Admin Panel's &quot;REST - OAuth Consumers page&quot;
    $consumerSecret = 'ozr74egldg07dpxtkk9uq1o8bj6wwd65'; // from Admin Panel's &quot;REST - OAuth Consumers page&quot;
    
    // Set the OAuth callback URL to this script since it contains the logic
    // to execute *after* the user authorizes this script to use the Coupon AutoGen API
    $callbackUrl = "http://127.0.0.1/magento/testscript.php";
    
    // Set the URLs below to match your Magento installation
    $temporaryCredentialsRequestUrl = "http://127.0.0.1/mage_restapi/oauth/initiate?oauth_callback=" . urlencode($callbackUrl);
    $adminAuthorizationUrl = 'http://127.0.0.1/mage_restapi/admin/oauth_authorize';
    $accessTokenRequestUrl = 'http://127.0.0.1/mage_restapi/oauth/token';
    $apiUrl = 'http://127.0.0.1/mage_restapi/api/rest';
    
    session_start();
    
    if (!isset($_GET['oauth_token']) && isset($_SESSION['state']) && $_SESSION['state'] == 1) {
        $_SESSION['state'] = 0;
        echo "try";
    }
    
    try {
    
        $authType = ($_SESSION['state'] == 2) ? OAUTH_AUTH_TYPE_AUTHORIZATION : OAUTH_AUTH_TYPE_URI;
        $oauthClient = new OAuth($consumerKey, $consumerSecret, OAUTH_SIG_METHOD_HMACSHA1, $authType);
    
        $oauthClient->enableDebug();
    
        if (!isset($_GET['oauth_token']) && !$_SESSION['state']) {
    
            $requestToken = $oauthClient->getRequestToken($temporaryCredentialsRequestUrl);
            $_SESSION['secret'] = $requestToken['oauth_token_secret'];
            $_SESSION['state'] = 1;
            header('Location: ' . $adminAuthorizationUrl . '?oauth_token=' . $requestToken['oauth_token']);
            exit;
        } else if ($_SESSION['state'] == 1) {
            $oauthClient->setToken($_GET['oauth_token'], $_SESSION['secret']);
            $accessToken = $oauthClient->getAccessToken($accessTokenRequestUrl);
            $_SESSION['state']  = 2;
            $_SESSION['token']  = $accessToken['oauth_token'];
            $_SESSION['secret'] = $accessToken['oauth_token_secret'];
            header('Location: ' . $callbackUrl);
            exit;
        } else {  
    
            // We have the OAuth client and token. Now, let's make the API call.
            $oauthClient->setToken($_SESSION['token'], $_SESSION['secret']);
    
    
    
            // Generate coupon codes via POST
            $resourceUrl = "$apiUrl/custom";
    
            $oauthClient->fetch($resourceUrl, OAUTH_HTTP_METHOD_POST, array(
                'Accept' => 'application/json',
                'Content-Type' => 'application/json',
            ));
    
    
             $data= json_decode($oauthClient->getLastResponse(), true);
    
    
            echo "Data is:<br/>".$data;
    
        }
    } catch (OAuthException $e) {
    
        print_r($e->getMessage());
        //echo "<br/>";
        //print_r($e->lastResponse);
    }
    

    当我尝试访问API时,它会要求授权

      

    授权应用程序管理员请求访问您的帐户

         

    授权申请后,您可以访问自己的帐户。

         

    授权按钮和拒绝按钮

    点击授权按钮错误 - :

    无效的身份验证/错误请求(获得404,预期的HTTP / 1.1 20X或重定向) {“messages”:{“error”:[{“code”:404,“message”:“请求与任何路由都不匹配。”}]}}

    PHP OAuth扩展程序在我的OAuth设置中不支持RSA-SHA1支持

    参考链接 http://www.magentocommerce.com/knowledge-base/entry/how-to-use-extend-the-magento-rest-api-to-use-coupon-auto-generation

    http://ctodilemma.com/2013/04/customising-and-extending-the-magento-rest-api/

    我们只使用magento提供的函数来访问其余的代码,下面是函数列表 - :

    1. _create()
    2. _retrieve()
    3. _delete()
    4. _retrieveCollection()
    5. _Update()
    6. _multiUpdate()
    7. _multiDelete
    8. 错误 无效的身份验证/错误请求(获得404,预期的HTTP / 1.1 20X或重定向) {“messages”:{“error”:[{“code”:404,“message”:“请求与任何路由都不匹配。”}]}}

      我已在上面分享了我的所有分析,但我无法访问数据。请分享您的反馈。

2 个答案:

答案 0 :(得分:2)

Core API允许您管理Magento中使用的一组公共资源。但是,您可以选择使用自己的一组资源进行管理,或者您可能希望扩展Core API以处理其他资源。

这将有助于创建自定义API。

http://devdocs.magento.com/guides/m1x/api/soap/create_your_own_api.html

答案 1 :(得分:0)

您的资源网址应与您的api2.xml中的网址相对应

$resourceUrl = "$apiUrl/custom";

应该是:

$resourceUrl = "$apiUrl/custom/createwebsite/"

$ apiUrl / custom / createwebsite / :s 末尾的:s代表什么?