Introduction to the platform onboarding guide

Prev Next

The NewStore Partner Onboarding program is a set of step-by-step tutorials on how to set up the NewStore platform. The modules provide a guideline through basic platform functionality and help you navigate the platform documentation. Each module describes a scenario given to you by a fictitious retail executive and invites you to play with the platform, its config and APIs, and experiment with what is possible.

Audience

The NewStore Partner Onboarding program is targeted to

  • New System Integrator Partners that are in the process of onboarding into the NewStore Partner program

  • Developers onboarding as new Employees into those Partners

  • Retailer internal developer teams

Content

The modules covered in this area are broken up by OMNI functionality to match typical deployment strategies. These include.

Preparation

Before you start on these modules, please make sure you have the following resources/tools in place.

  • A freshly created sandbox environment of the NewStore Platform. Please request a blank system vis your point of contact in NewStore.

  • An Apple Business Manager Account (ABM), see the separate document “Application Deployments using ABM”

  • Postman or a similar tool to perform API calls.

  • A data storage system that allows you to upload files that can be made available publicly or via a signed URL (e.g. AWS S3)

  • A system enabling you to host and run simple integration applications that respond to a NewStore webhook callback in a defined manner. (e.g. AWS Lambda + API Gateway)

  • As you make different API calls, you will need to generate an API Credentials token. Use this documentation to create a new credential. Make sure you select the right scope/privilege while creating the API credentials, as you will not be able to modify it later.

Important

As you follow the documentation you will see URLs specified as https://{{tenant}}.newstore.net. This is only an example. Your URL will replace {{tenant}} with the name of your sandbox - such as - https://partnerenablement-ex.p.newstore.net/.

Feedback

We’d like to encourage you to provide feedback how we can further improve the onboarding modules.