REST API: Overview

This page documents the REST API feature available as of v1.8.10.0 of MageRewards for Magento.
Documentation for the deprecated SOAP API feature, can be found here.

Outline

Overview

API Access & Authentication
Response Formats

Setup
Resources
Testing

Overview

The MageRewards API allows a remote interface for authorized external sources to access MageRewards data. You can use this to integrate MageRewards with third party applications which are not necessarily using the Magento system.

This API package is based on REST technology, supported as of Magento Enterprise 1.12 and Community 1.7 or higher. Read more about support in Magento 1.x.

API Access & Authentication

Magento 1.x uses oAuth 1.0 as the authentication method for API calls.
The oAuth process is explained in detail on Magento's documentation site under REST Authentication.

Response Formats

Similar to Magento's REST API, MageRewards also supports XML and json responses based on the Accept request header.
More details are explained on Magento's documentation site under REST Response Formats.