Gateway API Overview

Prerequisites

Before you begin integration, ensure the following:

  • You have an active merchant account with nicheclear.
  • You have access to the Shop API Key to call API endpoints and the Shop Signing Key for webhook verification. The keys for the sandbox and production environments are different.
  • All requests must:
    • Use HTTPS (base URL: https://engine.nicheclear.ca for production, https://engine-sandbox.nicheclear.ca for sandbox environment)
    • Be made using HTTP POST, GET, or PATCH methods as specified
    • Include the Shop API Key in the Authorization header as a Bearer token
    • Use JSON as the request body format for POST and PATCH methods