Arcadier Marketplace API   >  Get Started

Get Started

To obtain your APIs credentials, you will first need to create a trial sandbox marketplace. The steps below detail how you access the API's and start testing their behaviour.

Create your Sandbox Marketplace

  1. Go to the Arcadier sandbox sign up page. (https://www.sandbox.arcadier.io/masteradmin/onboard).
  2. Sign up with your preferred openID (Note: This will be the admin login for your sandbox as well!) and fill in the required fields.
  3. Select the marketplace type you would like:
    • Retail Goods for BESPOKE
    • Rental Goods by Location for SPACE
    • Space Rental for SPACE
    • Rental Goods by Type for Time
    • Service Bookings for Time
  4. Take note of your Marketplace Name as it will affect the URL of your sandbox marketplace
    e.g. https://{mymarketplacename}.sandbox.arcadier.io
  5. Also take note of the Currency selected as your sandbox marketplace will transact in this currency.
  6. Complete the sign up flow by filling in the rest of the required fields.
  7. You will receive an email indicating that your marketplace has been successfully setup and you may now login to the Admin Portal.

Get your Client ID & Secret

  1. Access your admin portal, login to https://{mymarketplacename}.sandbox.arcadier.io/admin
    If you have just created your sandbox marketplace, skip the get started tutorial.
  2. Go to your Account Info.
  3. Your Client ID & Secret will be displayed on the bottom of your account info (seen below).

From a security perspective, these credentials are sensitive – please treat them with the same caution that you would treat a private key or root password.


Trying API Calls Using Swagger

  1. Ensure that you are logged in to your Admin portal https://{mymarketplacename}.sandbox.arcadier.io/admin.
  2. Using the same browser go to https://{mymarketplacename}.sandbox.arcadier.io/swagger/ (the end "/" is important).
  3. Our full list of available APIs can be found in the left column of the swagger page.
  4. The parameters, response type and response message will be shown in the right column of the page.

The API parameters will reflect the marketplace type selected during your sandbox marketplace sign up. (i.e. Retail & Goods will give you BESPOKE APIs while the other 4 will give you SPACE/TIME APIs)

Some APIs such as 'Item search', 'Item Detail', 'Categories' can be used without any user authorization (logging in). Simply click on [TRY] to get a response.

Trying API Calls that Requires Authorization

Other APIs such as 'Order history', 'Order details', 'View carts', 'Add an item to shopping cart', 'Update a cart item', 'Remove an item from shopping cart' and 'Check out' require authorization.

  1. Click on [ OAUTH ] on any of the APIs listed above and you will the following pop-up:
  2. Select admin and click [ AUTHORIZE ].
  3. Login again with your Google credentials used for your sandbox marketplace.
  4. You will be redirected back to the swagger page with an access token (shown below).

This access token will expire in 5 days, however it's recommended to save the access token somewhere, as you would have to key in the token again upon refreshing the swagger page.

5. After keying in the access token, you can now start calling the API by hitting the [TRY] button.

Back To Top