root

The API root resource at https://api.bootic.net/v1.

This resource is the entry point to the API, and it includes links to all top-level resources as well as embedded information on the curently logged-in user and the shops they own.

HTTP GET

  curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.bootic.net/v1

Status: 200 OK
Content-Type: application/json; charset=utf-8
Connection: keep-alive
ETag: "0728e2965bd03e20a7f1c33add2f8775"
Last-Modified: Fri, 20 Jun 2014 22:34:14 GMT
Cache-Control: must-revalidate, private, max-age=0
Date: Wed, 31 Jul 2013 21:11:52 GMT
X-OAuth-Scopes: public
{
  "_links": {
    "curies": [
      {
        "name": "btc",
        "href": "http://developers.bootic.net/rels/{rel}",
        "templated": true
      }
    ],
    "btc:all_products": {
      "title": "All products, with search and filters",
      "templated": true,
      "href": "https://api.bootic.net/v1/products{?q,page,per_page,status,shop_subdomains,collections,shop_ids,type_ids,tags,global_tags,variants,sku,currency,price.gte,price.lte,discount_percentage.gte,discount_percentage.lte,created_on.gte,created_on.lte,updated_on.gte,updated_on.lte,account_status,account_plan,sort,facets}"
    },
    "btc:docs": {
      "href": "http://developers.bootic.net",
      "type": "text/html",
      "title": "API Documentation site"
    }
  },
  "uid": 2,
  "last_logged_on": "2014-05-09T11:08:31.000Z",
  "email": "user@site.com",
  "user_name": "johnnie85",
  "provider": "bootic",
  "scopes": "admin,public",
  "_embedded": {
    "shops": [
      {
        "_links": {
          "self": {
            "href": "https://api.bootic.net/v1/shops/455"
          },
          "btc:orders": {
            "href": "https://api.bootic.net/v1/shops/455/orders"
          },
          "btc:contacts": {
            "href": "https://api.bootic.net/v1/shops/455/contacts{?q,sort}",
            "templated": true
          },
          "btc:products": {
            "href": "https://api.bootic.net/v1/products?shop_ids=455"
          },
          "btc:web": {
            "href": "http://www.bootic.net",
            "type": "text/html"
          },
          "btc:theme": {
            "href": "https://api.bootic.net/v1/shops/455/theme"
          },
          "btc:variant": {
            "href": "https://api.bootic.net/v1/shops/455/products/{product_id}/variants/{id}",
            "templated": true
          },
          "btc:create_variant": {
            "href": "https://api.bootic.net/v1/shops/455/products/{product_id}/variants",
            "templated": true,
            "method": "post"
          },
          "btc:update_variant": {
            "href": "https://api.bootic.net/v1/shops/453/products/{product_id}/variants/{id}",
            "templated": true,
            "method": "put"
          },
          "btc:delete_variant": {
            "href": "https://api.bootic.net/v1/shops/453/products/{product_id}/variants/{id}",
            "templated": true,
            "method": "delete"
          }
        },
        "id": 47,
        "subdomain": "acme",
        "url": "acme.bootic.net",
        "name": "Acme",
        "created_on": "Wed, 12 Sep 2012 11:34:04 +0000",
        "updated_on": "Fri, 20 Jun 2014 13:46:49 +0000",
        "description": "A shop",
        "locale": "en",
        "currency_code": "CLP"
      }
    ]
  }
}

From the root resource your client code can navigate to search allowed products across Bootic (depending on your scope) by following the all_products link, or search shops with the all_shops link.

The embedded shops array lists your own shops. Each shop may contain aditional links, depending on your scope’s permissions.
See the shop documentation.

Single Sign On

This resource contains information on the current user and scopes (the user who requested the access token), so it can be used for Single Sign On functionality using OAuth2’s Authorization Code Grant.

The OmniAuth Bootic Ruby gem queries this resource to add Single Sign On functionality to Ruby apps.