Placewise API
Get startedExplore
Get startedExplore
Performance Cloud 🗗
Placewise 🗗
  1. Get started
  • Introduction
  • Global Headers
  • Common HTTP Error Codes
  • API Permits
  • Rate Limiting
  • Authorization
    • Token Authorization
    • Member Authorization
    • User Authorization
  • API Contexts
    • Customer Context
    • LoyaltyClub Context
    • Global Context
  • Common Concepts
    • Localization
    • System URLs
    • Params Validation
    • Pagination
    • Sorting
  • Common Models
    • Common Data Formats
    • Member Model
    • API Entity Model
    • Opening Hours Model
  1. Get started

Global Headers

Content-Type header#

The API supports application/json only.
Both payload and response body are supposed to be a valid JSON so when making a request send a Content-Type: application/json header.
If payload is not a valid JSON, then 400 Bad Request HTTP code and empty response body are returned.

X-User-Agent header#

Example header: X-User-Agent: Infinity Mall Android App
X-User-Agent is required to distinguish specific client for information and debugging purposes so we better know who uses the service.
It should be arbitrarily chosen to represent client specifics (e.g. 'Infinity Mall Android App v1.2' or 'Infinity Mall Backend Service')

X-Product-Name#

Example header: X-Product-Name: android-app
Each system that is communicating with us should uniquely identify itself so it is possible to distinguish optin/update channels.
That will allow further targeting members by communication channel.
For that we use product name. It should be passed as required header X-Product-Name that is intended to provide the necessary granularity.
If you miss your product name, please let us know.

X-Loyalty-Club-Slug header#

See: LoyaltyClub Context

X-Customer header#

See: Customer Context

X-Client-Authorization header#

See: Client Authorization

X-Locale header#

See: Localization

Authorization header#

See: Member Authorization or User Authorization
Previous
Introduction
Next
Common HTTP Error Codes
Built with