Simple Store
  • What is Simple Store?
  • Getting Started
    • Portal
      • Environments
      • Configuring Your Store
    • Creating Your First Product
    • QuickBuy
  • Concepts
    • Assets
      • Image Resizing
    • Cart
    • Categories
    • Configuration
    • Collections
    • Customers
    • Inventory
    • Orders
    • Payments
    • Pricing
    • Product
    • Rewards
    • Shipping
    • Specials
  • API
  • Front End Client APIs
  • Backend APIs
  • Pagination
  • Swagger References
Powered by GitBook
On this page
  • API Key
  • Token Authentication
  • Swagger References

Front End Client APIs

PreviousSpecialsNextBackend APIs

Last updated 4 years ago

Client APIs support the implementation of the Simple Store API into public facing channels like a web or mobile application.

API Key

All Front End Client APIs must include an API Key which is associated with your Simple Store (Tenant) Account.

the API key is passed onto each request using the header: x-api-key

Token Authentication

A subset of the Client API support functionality tied to specific customers, examples include:

  • Change Customer Details

  • Change Password

  • Get Order History

A token is issued by calling the method on the Client API:

curl -d '{"emailAddress":"email address", "password":"password"}' \
     -H "Content-Type: application/json" \
     -H "x-api-key: [api-key]"
     -X POST https://clients.api.simplestore.io/v1/customer/login

Swagger References

[login]
https://clients.api.simplestore.io/swagger/index.html