Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
38 lines (22 sloc) 1.8 KB
description
A comprehensive reference guide to Commerce Layer REST API

Introduction

Commerce Layer exposes a fast REST API that lets you add ecommerce to your favorite tech stack. This guide is your reference for all the operations that you can perform on the API resources.

Base endpoint

All API requests must be made over HTTPS to the following base endpoint:

https://yourdomain.commercelayer.io

Where yourdomain is the unique subdomain of your organization.

API Specification

Commerce Layer API is 100% compliant with the JSON API specification (v1.0). It supports compound documents, sparse fieldsets, resource linking, filtering, sorting, pagination and more. The JSON API community has shared some client libraries that can help you get started.

Official libraries and SDKs for the most popular languages are coming soon.

Applications

Commerce Layer implements the industry-standard OAuth 2.0 protocol to manage clients authorization. It defines three types of applications. Which application to use depends on your specific use case. Official guides and tutorials for the most popular use cases are coming soon.

Environments

For each organization, you can work either in test mode (default) or live mode.

{% hint style="info" %} Working in test mode is free forever. You can try Commerce Layer in test mode as long as you need. {% endhint %}

Test mode also provides you with a development environment after the go-live. All API calls are identical between the two environments. Use test or live application credentials to make the switch.

You can’t perform that action at this time.