Skip to content

Choose your path

Every caller of the API is an app, made in the partner portal and installed in an organization. Its kind, picked when it is created and fixed after, answers one question: who will use what you build?

  • One organization (your own ERP, warehouse system or internal script, or an integration an agency builds for one client): a private app. No store listing, no review; an administrator of that organization approves it through its install link, and your server takes its tokens with OAuth client credentials. Private apps.
  • Many merchants, each in their own organization (software you sell or offer to others): a public app. It is listed in the app store once reviewed, and each merchant installs it through OAuth authorization code. Your app.

Unsure? Start with a private app in a test organization: first call. The API, the scopes and the responses are the same for both kinds, so the code that calls the API carries over to a public app later.

Private app Public app
Who uses it One organization, chosen at creation Every merchant who installs it
Made in The partner portal The partner portal
Partner account Needed Needed
Installed from Its install link, sent to an administrator of the organization The app store, or your own connect button, through OAuth
Access granted by An administrator of the organization, on the approval page Each merchant, on the consent screen
Tokens Client credentials: the app's client ID and secret, no redirect, no refresh token Authorization code with PKCE, a redirect URI, refresh tokens
Review None: you publish each version Before each version reaches the store
Store listing None Required
Webhooks Yes, signed Yes, signed
Belongs to The organization's installation The installation, in each organization

Shared by both: the same endpoints, the same scopes capped by the approver's permissions, the same errors, pagination, idempotency, rate limits and webhooks. Neither belongs to a person: an installation keeps working after the person who approved it leaves, and the merchant sees every call.

  • Dashboard: the web app where merchants work with their orders, shipments and invoices, at https://connectato.com/app. Merchants install apps there and see them in Applications → My applications.
  • Partner portal: where apps are made, at https://partners.connectato.com. Anyone building an app has a partner account, a merchant integrating their own organization too.
  • Organization: one merchant's business in the dashboard. Every installation belongs to exactly one.
  • App: what calls the API, private or public. Never the dashboard.