APX REST API Integration

Creating an API Login

MarketSuite® Accounts will have dedicated logins for accessing the REST APIs. Regular user logins will not be able to authenticate through the API. Contact your APX Account Manager if you need a login.

OpenAPI Technical API Specification

MarketSuite® uses the Swagger specification to describe the integration API endpoints available to consumers. Provided is a swagger.json file (available on registry website; see links below) that contains the definitions of the endpoints that will allow you to become familiar with the requests and responses provided. You can follow the steps outlined below to get started. There is also a Swagger page available through the registry website (see links below)

  • Swagger.json file: Prod | UAT
  • Swagger UI Page: Prod | UAT

View MarketSuite® APIs on Swagger

  1. Navigate to the Swagger website. This site is the community site that describes the swagger specification and has demonstrations and downloads available
  2. Go to the demo area. This will take you to a hosted solution where you can view the definitions and generate servers and clients in many mainstream languages. You will need to create the client code for consumption of the endpoints. The server generated code can be used to create stubs to simulate interactions with the live endpoint.
  3. Upload the MarketSuite® Swagger API json file (see links, above) to the swagger editor
    •               Go to “File” menu item
    •               Go to the “Import File” menu item
    •               Navigate to the file location
    •               Upload the file
  4. You can now view the MarketSuite API definitions in the right-hand pane. (The “Warnings” can be ignored as they are alerting you to a non-standard description field that is generated)

Generate Client for MarketSuite® APIs

  1. Perform the “View MarketSuite® APIs” as described above.
  2. Select the “Generate Client” menu item.
  3. Select your language of choice and download the SDK
    •               This will download an SDK in your language of choice. Please note that you may need to make modifications to the toolkit (e.g. Username / Passwords, Endpoint URL changes, et al).
    •               This can serve as a starting point to setting up your code to consume the MarketSuite® APIs.

Generate Server for MarketSuite® APIs

  1. Perform the “View MarketSuite® APIs” as described above.
  2. Select the “Generate Server” menu item.
  3. Select your language of choice.
    •               This will download an SDK in your language of choice. Please note that you may need to make modifications to the toolkit (e.g. Username / Passwords, Endpoint URL changes, et al).
    •               This can serve as a starting point to setting up the server APIs stub.