Make your Magento API integration easier for third parties with this module.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dev/tests/apiplus Adding more testings. Oct 8, 2016
setup
src/app Merge pull request #7 from rafaelstz/patch-4 Apr 19, 2018
.gitignore Starting the base of the module. Sep 23, 2016
.travis.yml
LICENSE.txt
README.md
modman

README.md

API Plus for Magento

Build Status GitHub license GitHub issues GitHub forks GitHub license

Rather than using (slow) SOAP to make calls to Magento's API why not to simply send a POST to an endpoint provinding your authentication data in request header and a JSON-encoded body with the resource name you want to consume and arguments needed for the call?

API Plus for Magento is a module that improves how Magendo API can be consumed by third party applications. By using API Plus in your Magento store you make the API connection much eaiser but with the same abstraction layer and providing the same flexibility and security that Magento platform already provides for all its community.

NOTE

This documentation is not complete but I'm working on it to improve and make it better everytime I have a little free time.

Features

  • Much easier!: API Plus is much, much, much easier to be used in your Magento platform. By using it you don't need to make SOAP calls anymore.
  • Flexibility: API Plus uses the Magento API's abstraction so, the same flexibility is provided by API Plus.
  • Security: API Plus is as secure as Magento's authentication system.
  • Performance: By using API Plus your API connections and results will be much faster then using the default SOAP calls.

Authors, contributors and maintainers

Author:

Compability

  • PHP:
    • 5.4
    • 5.5
    • 5.6
  • Magento CE:
    • 1.6.x
    • 1.7.x
    • 1.8.x
    • 1.9.x
  • Magento EE:
    • 1.11.x
    • 1.12.x
    • 1.13.x
    • 1.14.x

Documentation

Basic

It's quite simple! Rather then using SOAP process described in Magento Webservice Documentation all you need to do is to send a POST request to:

https://www.yourmagentohost.com/api/json

Providing the following authentication parameters in request header:

Parameter Key Parameter Value
apiUsername [Your Magento's API Username]
apiKey [Your Magento's API Secret Key]

And the body in JSON format:

{
  "resource": "catalog_product.list"
}

If you need to send any arguments, like you do in SOAP request for some resources, you simply add a new node called args in the JSON request body:

{
  "resource": "catalog_product.list",
  "args": {
    "complex_filter": [
      {
        "key": "type",
        "value": {
          "key": "in",
          "value": "configurable,grouped"
        }
      }
    ]
  }
}

Links

🇧🇷 Novo Módulo Magento para Integração com API: API Plus!

License

(c) 2016 MIT License - Tiago Sampaio