Skip to content
Ideasoft
App Store

Getting Started

1. Test store

Once the partnership and contract steps are complete, the Ideasoft App Store team sets up a test store such as your-store.myideasoft.com for development. You build and test your app against this store's admin panel and API.

2. API access during testing

During development you create an API registration in your test store's admin panel under Integrations → API → Add:

  • You enter the Redirect URL.
  • The Client ID and Client Secret are generated by the system.
  • You grant read or read/write permissions for the areas your app needs on the same screen.

The authorization and token steps for this registration are described on the Authentication page.

3. Published app registration

Apps published on the App Store work differently:

  • The Client ID and Client Secret are issued by Ideasoft and are fixed across all stores; there are no per-store keys. They are shared with you after your testing is complete.
  • Your Redirect URL and Uninstall Hook URL are registered with these credentials.
  • The permissions your app requests (read, read/write) are defined in the app registration and shown to the merchant on the consent screen during installation.
  • Merchants do not create an API registration in their panel; authorization happens through the consent screen Ideasoft shows during App Store installation.

Keep your Client Secret private

The Client Secret is used to obtain tokens and to verify the state, hmac and hash signatures. Store it on the server only; never put it in a browser, a mobile app, URLs or logs.

4. Required URLs

URLPurposeRequirements
Redirect URLWhere the merchant is sent on installation and on every opening, with state, code, domain and user_id.Must be sent exactly as registered in authorization requests. For embedded apps it must not contain a query string (?…).
Uninstall Hook URLReceives a JSON notification when your app is uninstalled.Must accept POST and return HTTP 200 on success.

Both URLs must be dedicated to Ideasoft and use HTTPS.

Readiness checklist

  • The test store is set up and you can access its admin panel.
  • An API registration exists in the test store and you can obtain tokens.
  • The Redirect URL verifies state (Installation and Authorization).
  • The Uninstall Hook URL verifies hash and returns HTTP 200 (Uninstall).
  • If your app runs inside the panel, hmac verification is in place (Embedded Apps).
Last modified on