Skip to main content

Overview

App Manifest

The App manifest is a JSON file that describes the application details, including name and version. It lists the required by the App permissions. Defines App mounting points in the Dashboard and specify the Auth Persistence.

App Requirements

BoxNCase Commerce API requires two endpoints to be implemented on the App side - the Manifest URL and Register URL.

Communication with BoxNCase Commerce API

Depending on App needs it can communicate with the BoxNCase Commerce API using events based on webhooks or with BoxNCase Commerce GraphQL API. Check "Communicating with apps" for more details.

Auth Persistence

BoxNCase Apps communicate with BoxNCase Commerce API using token - obtained during App registration process. The Auth Persistence Layer page describes the ways you can store obtained token depending on your App needs.

info

If you're building a single service dedicated only to your shop, check Webhooks section of Extending dashboard as it may handle all your needs.