Introduction

The Arctic UI API are the available endpoints for building UI applications to view and interact with the Arctic project core.

This SDK gives you a programmable way to interact with the UI API. You can also explore the API in a more interactive and direct way via our Swagger documentation.

Installation

gem 'arctic-ui'

Configuration

require 'arctic/ui'

Arctic::UI.configure do |config|
  config.client_id = "CLIENT_ID"
  config.client_secret = "CLIENT_SECRET"
end

Make sure to replace YOUR_CLIENT_ID and YOUR_CLIENT_SECRET with the information from the account given to you.

After we have setup an account for you, you will get a CLIENT_ID and CLIENT_SECRET.

The CLIENT_ID and the CLIENT_SECRET should be stored inside your application in a secure way.

To get a set of credentials, please get in touch with us.

Authentication

require 'arctic/ui'

api = Arctic::UI::API.new email, password

The email and password should be supplied by the user. The user should be associated with your account.

You can setup, create and manage users for your account in your Arctic Backoffice.

Throttling / Rate limiting

api.get_throttling

Example response

{
  "credits": 67,
  "total": 100,
  "timeout": "Wed, 21 Oct 2015 07:28:00 GMT",
}

Every endpoint has a cost to prevent abuse. Every account has a number of rate-credits, and the cost of the endpoint is deducted everytime an endpoint is called. The credits are regenerated at a pre-configured rate.

Response fields

Every endpoint documents the cost of using the endpoint.

Account

Get account information

api.get_account

Example response

{
  "id": "735108ed-55ef-4314-8295-b57fb0d1e05c",
  "name": "Bob's webshop"
}

Throttling cost: 1

The user's account represents the account object. This is the central object that all users and shops are related to. This also holds your rate limit information (see the Rate Limiting section).

Update account information

api.update_account name: 'New Account Name'

Example response

{
  "id": "735108ed-55ef-4314-8295-b57fb0d1e05c",
  "name": "New Account Name"
}

Throttling cost: 25

Possible account attributes you can update

Shops

List shops

api.get_shops

Example response

[
  {
    "id": "2270b57a-80ee-4a44-9cd3-014c0469b39d",
    "name": "Danish shop"
  },
  {
    "id": "a30c348a-0396-4c86-8aee-3af3c782862c",
    "name": "Swedish shop"
  }
]

This will return a list of the shops available on your account.

Update an existing shop's information

api.update_shops \
  id: 'a30c348a-0396-4c86-8aee-3af3c782862c',
  name: 'Norwegian shop'

Example response

{
  "id": "a30c348a-0396-4c86-8aee-3af3c782862c",
  "name": "Norwegian shop"
}

Possible shop attributes to update

List configured preprocessors

api.get_shop_preprocessors \
  shop_id: 'a30c348a-0396-4c86-8aee-3af3c782862c'

Example response

[
  {
    "id": "a30c348a-0396-4c86-8aee-3af3c782862c",
    "name": "Amazon UK",
    "preprocessor_id": "062da138-c0c1-46b2-b0fd-b43f9a2ad888",
    "auth_config": {
      "username": "some@email.com",
      "password": "password"
    },
    "format_config": {
      "rename": {
        "SOME_FIELD": "id"
      }
    },
    "config": {
      "url": "ecommerse.com/api"
    }
  },
  {
    "id": "8c4e6d26-4b4d-40c8-88b5-ad814294ce39",
    "name": "Alibaba",
    "preprocessor_id": "c4cc916b-441f-4244-9ce3-c0cc81a5cc44",
    "auth_config": {
      "username": "some@email.com",
      "password": "password"
    },
    "format_config": {
      "rename": {
        "SOME_FIELD": "id"
      }
    },
    "config": {
      "url": "ecommerse.com/api"
    }
  }
]

You can retrieve a list of all the preprocessors configures on the shop.

Add a preprocessor

api.add_shop_preprocessor \
  shop_id: 'a30c348a-0396-4c86-8aee-3af3c782862c',
  preprocessor_id: '8680cc9b-12d5-4bbd-a4ff-f176ef90d676',
  config: {
    url: 'https://e-commerse-system.com/api',
  },
  auth_config: {
    username: 'some@email.com',
    password: 'password',
  },
  format_config: {
    rename: {
      NAME: :name,
      SIZE: :size,
    },
    aggregate: {
      id: [:name, :size],
    },
    remove: [ :size ],
  },

Example response

{
  "id": "d0062fe4-f378-4179-99ab-f5b0b388df85",
  "name": "Dandomain",
  "preprocessor_id": "8680cc9b-12d5-4bbd-a4ff-f176ef90d676",
  "auth_config": {
    "username": "some@email.com",
    "password": "password"
  },
  "format_config": {
    "rename": {
      "NAME": "name",
      "SIZE": "size",
    },
    "aggregate": {
      "id": ["name", "size"],
    },
    "remove": [ "size" ],
  }
}

In order to distribute products from your shop to other platforms you must add a preprocessor. Here you will need to set credentials and/or other information that will allow us to access your webshop or ERP system and retrieve your products.

Update a preprocessor

api.update_shop_preprocessor \
  id: 'd0062fe4-f378-4179-99ab-f5b0b388df85'
  shop_id: 'a30c348a-0396-4c86-8aee-3af3c782862c',
  auth_config: {
    username: 'new@email.com',
    password: 'new-password',
  }

Example response

{
  "id": "d0062fe4-f378-4179-99ab-f5b0b388df85",
  "name": "Dandomain",
  "preprocessor_id": "8680cc9b-12d5-4bbd-a4ff-f176ef90d676",
  "auth_config": {
    "username": "new@email.com",
    "password": "new-password"
  }
}

If the credentials for the webshop system changes, then you will need to update the preprocessor configurations as well with the new credentials and/or other configurations.

Preprocessors

List available preprocessors

api.get_preprocessors

Example response

[
  {
    "id": "8680cc9b-12d5-4bbd-a4ff-f176ef90d676",
    "name": "Dandomain"
  },
  {
    "id": "062da138-c0c1-46b2-b0fd-b43f9a2ad888",
    "name": "Amazon UK"
  },
  {
    "id": "c4cc916b-441f-4244-9ce3-c0cc81a5cc44",
    "name": "Alibaba"
  }
]

A preprocessor represents a connection between where you're hosting your webshop (e.g. Dandomain) and our system. A preprocessor will pull the items from your system into the Arctic system, from where they will be distributed throug Postprocessors.

Errors

Example error response

{
  "error": "Unauthorized",
  "description": "Invalid or missing Bearer token Authentication header"
}

The Arctic Core API uses the HTTP status codes list. Here is some additional explenations for some of the HTTP status codes.