Knowledge Base


  • Video block
  • Video Tutorials

  • Watch our easy-to-follow video tutorials for quick tips on designing and managing your store.
  • View Video Tutorials

Activating Web Services

Web Services give you the ability to integrate with third-party applications by granting them permission to access specific store resources and data.

Step 1: Create a Web Service Role

  1. From the Admin menu, select System > Web Services > Roles.
  2. Web Services - Roles
    Web Services - Roles

  3. Click the Add New Role button.
  4. In the Role Information section, enter a Role Name such as “API.”
  5. Role Information
    Role Information

  6. In the panel on the left, select Role Resources. Then do one of the following:
    • To enable full access to customer, catalog, and sales information, set Resource Access to “All.”
    • To provide limited access to data, set Resource Access to “Custom.” Then, select the checkbox of each resource that is available to this role.
    • By default, when a area is selected, full access is granted. You can accept the default, specify the actions that a person is allowed to take. Specific types of access are listed under many of the resource links, so it is easy to determine exactly what a user is allowed to do with each resource.
  7. When complete, click the Save Role button.

Step 2: Create a Web Service User

  1. From the Admin menu, select Web Services > Users.
  2. Click the Add New User button.
  3. Complete the following fields:
    • User Name
    • First Name
    • Last Name
    • Email
  4. In the API Key field, enter a verification key or password. This is the credential that third-party web services must use to access your Magento Go store.
  5. To confirm, re-enter the key in the API Key Confirmation field.
  6. In the panel on the left, select User Role. Then, select a Role for the user.
  7. When complete, click the Save User button.

Step 3: Add Custom Scripts to Your Store

Some third-party web services use JavaScript code snippets to gather data. Some web services require you to insert code in the <head> section of the HTML, while others require the code to be inserted in the footer, just below the closing </body> tag.

See also:

WS-I Compliance

Magento Go API Refererence