$ npm install @adobe/aio-lib-magento

1. Initialize the SDK

const sdk = require('@adobe/aio-lib-magento')

async function sdkTest() {
  //initialize sdk
  const client = await sdk.init('<tenant>', 'x-api-key', '<valid auth token>')
}

2. Call methods using the initialized SDK

const sdk = require('@adobe/aio-lib-magento')

async function sdkTest() {
  // initialize sdk
  const client = await sdk.init('<tenant>', 'x-api-key', '<valid auth token>')

  // call methods
  try {
    // get profiles by custom filters
    const result = await client.getSomething({})
    console.log(result)

  } catch (e) {
    console.error(e)
  }
}

MagentoCoreAPI

This class provides methods to call your MagentoCoreAPI APIs. Before calling any method initialize the instance by calling the init method on it with valid values for tenantId, apiKey and accessToken

init(tenantId, apiKey, accessToken) ⇒ Promise.<MagentoCoreAPI>

Returns a Promise that resolves with a new MagentoCoreAPI object.

MyParameters : object

An example of a typed object.

AnotherThing : object

Another typed object.

This class provides methods to call your MagentoCoreAPI APIs. Before calling any method initialize the instance by calling the init method on it with valid values for tenantId, apiKey and accessToken

Kind: global class

• MagentoCoreAPI
  • .tenantId : string
  • .apiKey : string
  • .accessToken : string
  • .init(tenantId, apiKey, accessToken) ⇒ Promise.<MagentoCoreAPI>
  • .getSomething([parameters]) ⇒ Promise.<Response>

The tenant id

Kind: instance property of MagentoCoreAPI

The api key from your integration

Kind: instance property of MagentoCoreAPI

The access token from your integration

Kind: instance property of MagentoCoreAPI

Initializes a MagentoCoreAPI object and returns it.

Kind: instance method of MagentoCoreAPI
Returns: Promise.<MagentoCoreAPI> - a MagentoCoreAPI object

Get something.

Kind: instance method of MagentoCoreAPI
Returns: Promise.<Response> - the response

Returns a Promise that resolves with a new MagentoCoreAPI object.

Kind: global function
Returns: Promise.<MagentoCoreAPI> - a Promise with a MagentoCoreAPI object

An example of a typed object.

Kind: global typedef
Properties

Another typed object.

Kind: global typedef
Properties

LOG_LEVEL=debug <your_call_here>

Prepend the LOG_LEVEL environment variable and debug value to the call that invokes your function, on the command line. This should output a lot of debug data for your SDK calls.

Contributions are welcome! Read the Contributing Guide for more information.

This project is licensed under the Apache V2 License. See LICENSE for more information.