Как получить доступ к API Magento из собственного клиента с помощью JavaScript
Мне нужно получить доступ к API Magento из локального приложения на основе JavaScript (Titanium Desktop) и задаться вопросом, как это лучше всего сделать.
Что я узнал до сих пор:
- Единственным механизмом аутентификации является OAuth, поэтому пользователь должен ввести свои учетные данные на сайте
- Существует клиентская библиотека JavaScript: https://code.google.com/p/oauth/source/browse/#svn%2Fcode%2Fjavascript
- Для собственных приложений в качестве OAuth клиентам рекомендуется использовать Поток агента пользователя OAuth 2.
- URL-адрес перенаправления должен указывать на локальную страницу, с которой маркер должен быть извлечен или скопирован и вставлен
Вопросы:
- Возможно ли заменить механизм аутентификации на что-то вроде аутентификации на основе HMAC с ключом приложения и секретом? Существуют ли вообще проверенные решения?
- Если нет, возможен ли поток агента пользователя OAuth с помощью Magento? Документация не содержит упомяни об этом.
- Можно ли отправить учетные данные пользователя с помощью AJAX (политика перекрестного происхождения здесь не является проблемой), чтобы скрыть большую часть процесса авторизации от пользователя? Затем маркер доступа может быть извлечен непосредственно из ответа.
1 answers
Изменить: Найден лучший способ, см. Решение 2 ниже
Как упоминалось в комментарии, API SOAP - это правильный путь.
Решение 1:
Suds работал для меня с небольшими изменениями (использование Titanium.Network.HTTPClient
вместо XMLHttpRequest
), но это не намного больше, чем создание конверта SOAP для вызова и возврат всего XML-ответа.
Реализация доказательства концепции с использованием jQuery Отложенный для запроса цепочка:
Service.MagentoClient = function()
{
var self = this;
var suds = new SudsClient({
endpoint : "http://the-magento-host/api/v2_soap/",
targetNamespace : "urn:Magento",
});
self.login = function() {
var deferred = new $.Deferred();
var args = {
username : 'the-username',
apiKey: 'the-api-key'
};
suds.invoke("login", args, function(xmlDoc) {
self.sessionId = $(xmlDoc).find("loginReturn").text();
deferred.resolve({});
//TODO reject if no sessionid returned
});
return deferred;
};
self.setStatus = function(orderId, status, comment, notify) {
var deferred = new $.Deferred();
if (!self.sessionId) {
deferred.reject({ error: 'Login not successful.' });
return;
}
var args = {
sessionId : self.sessionId,
orderIncrementId : orderId,
status : status,
comment : comment,
notify : notify
}
suds.invoke("salesOrderAddComment", args, function(xmlDoc) {
var success = $(xmlDoc).find("salesOrderAddCommentResponse").text();
if (success) {
deferred.resolve({});
} else {
deferred.reject({ error: 'Update not successful.' });
}
});
return deferred;
};
};
Пример использования:
var magento = new Service.MagentoClient();
magento.login().then(function() {
magento.setStatus('100000029', 'complete', 'soap test');
}).then(function() {
alert('Update successful');
}, function(reject) {
alert('Update failed: ' + reject.error);
});
Решение 2:
Оказалось, что написать собственный адаптер API может быть очень просто. На примере этот основной взлом ( мертвая ссылка) Я смог написать чистый модуль для адаптера JSON-RPC на основе Zend_Json_Server
. Он использует ту же аутентификацию и ACL, что и API SOAP и XML-RPC.
Чтобы использовать точку входа /api/jsonrpc
, новый контроллер должен быть добавлен в api
маршрут:
<config>
<frontend>
<routers>
<api>
<args>
<modules>
<my_jsonrpc before="Mage_Api">My_JsonRpc_Api</my_jsonrpc>
</modules>
</args>
</api>
</routers>
</frontend>
</config>
Обновление 02/2015: Приведенная выше ссылка теперь мертва, поэтому я открываю свой адаптер JSON-RPC в качестве полного расширения: https://github.com/sgh-it/jsonrpc
Мой клиент JS теперь выглядит так (опять же с помощью jQuery.Отложенный, но без дополнительных сторонних библиотек для API):
/**
* Client for the Magento API
*/
Service.MagentoClient = function()
{
var self = this;
/**
* @param string method the remote procedure to call
* @param object params parameters for the RPC
* @param callback onSuccess callback for successful request. Expects one parameter (decoded response object)
* @param callback onError callback for failed request. Expects one parameter (error message)
*
* @return void
*/
self.jsonRpc = function(method, params, onSuccess, onError) {
var request = {
method : method,
params : params,
jsonrpc : "2.0",
id : 1
};
var options = {
entryPoint : config.magentoClient.entryPoint,
method: 'post',
timeout: config.magentoClient.timeout
};
var httpClient = Titanium.Network.createHTTPClient();
httpClient.onload = function(e) {
try {
var response = JSON.parse(this.responseText);
} catch (jsonError) {
return onError(jsonError);
}
if (response.error) {
if (response.error.code == 5) { // session expired
self.sessionId = null;
}
return onError(response.error.message);
}
onSuccess(response);
};
httpClient.onerror = function(e) {
onError(e.error + '; Response:' + this.responseText);
};
httpClient.setTimeout(options.timeout);
if (httpClient.open(options.method, options.entryPoint)) {
httpClient.setRequestHeader("Content-type", "application/json");
httpClient.send(JSON.stringify(request));
} else {
onError('cannot open connection');
}
}
/**
* Retrieve session id for API
*
* @return JQuery.Deferred deferred object for asynchronous chaining
*/
self.login = function() {
var deferred = new $.Deferred();
if (self.sessionId) {
deferred.resolve();
return deferred;
}
var loginParams = config.magentoClient.login;
try {
self.jsonRpc('login', loginParams, function(response) {
if (response && response.result) {
self.sessionId = response.result;
deferred.resolve();
} else {
deferred.reject('Login failed.');
}
}, function(error) {
deferred.reject(error);
});
} catch (rpcError) {
deferred.reject(rpcError);
}
return deferred;
};
/**
* Updates order states in Magento
*
* @param string method name of the remote method
* @param object args arguments for the remote method
*
* @return JQuery.Deferred deferred object for asynchronous chaining
*/
self.call = function(method, args) {
var deferred = new $.Deferred();
if (!self.sessionId) {
deferred.reject('No session.');
return;
}
var callParams = {
sessionId : self.sessionId,
apiPath : method,
args : args
};
try {
self.jsonRpc('call', callParams, function(response) {
deferred.resolve(response.result);
}, function(error) {
deferred.reject(error);
});
} catch (rpcError) {
deferred.reject(rpcError);
}
return deferred;
};
};
Обратите внимание, что все методы после входа в систему маршрутизируются через call
. Параметр method
представляет собой что-то вроде sales_order.list
, параметр args
представляет собой массив или объект с аргументами метода.
Пример использования:
var filters = [];
var magento = new Service.MagentoClient();
magento.login().then(function() {
magento.call('sales_order.list', [filters]).then(
function(orders) {
// do something with the response
}, function(error) {
alert('Magento API error: ' + error);
}
);
});