Your app
An app is created once, in the partner portal, and installed in each organization that uses it. Every member of the partner works with the apps (roles).
Creating it
Section titled "Creating it"From Apps, New app asks first for the kind, fixed from then on:
- Public: listed in the store once verified, installed by any organization through OAuth. It asks for a name, unique among public apps, and a redirect URI (absolute,
https,httponly for localhost). - Private: for one organization, no store and no review, installed through its link. It asks for a name and the organization it belongs to (private apps).
The client_id and client_secret are shown at once; the secret only once, so copy it then.
Until its first publication, a public app is not in the store and installs only in the partner's test organizations. This guide follows a public app; what differs for a private one is in private apps.
The app's page
Section titled "The app's page"At the top, three figures: live installations, calls in the last 7 days and the error rate over those calls. Below, five tabs (four for a private app, which has no store listing):
| Tab | What it holds |
|---|---|
| Details | The name, redirect URIs (a public app's), requested scopes, what the app provides, the client_id and secret, the version history and the Connect block. |
| Store listing | What a merchant sees in the app store. Public apps only. |
| Installations | A private app's install link, then every organization the app was installed in: its name and public id (org_...), installed at, scopes granted, state (live or uninstalled, with the date), last call. |
| Calls | The app's calls across its installations: moment, organization, operation (GET /v1/orders), status, error code, duration, idempotency key, request_id. Filters: organization, success or error, period. No bodies; 90 days. |
| Webhooks | The URL, events, signing secret, the test event, the state and the deliveries, with resend (webhooks). |
Credentials
Section titled "Credentials"- The
client_idis public; theclient_secretstays on the app's server. The client is confidential. A public app's client takes the authorization code (and its refresh token); a private app's, client credentials only (authentication). - The secret is replaced with Rotate the secret, with the password confirmed. The old secret is refused at once; tokens already issued stay valid until they expire or are revoked.
- The Connect block on Details gathers, ready to copy: the authorization URL (
https://connectato.com/oauth/authorize, a public app's only), the token URL (https://connectato.com/oauth/token), the API's base URL (https://api.connectato.com/v1) and the OAuth and webhooks guides.
Installing it in a test organization
Section titled "Installing it in a test organization"A public app's test installation goes through the same flow as a merchant's, started by your app (a private app made for a test organization installs there through its install link):
-
Create a test organization, if you have none.
-
From your app, start the OAuth flow with the app's
client_id, a registered redirect URI, the scopes and PKCE (OAuth). -
On the consent screen, pick the test organization and approve.
-
Exchange the code for tokens and call
GET https://api.connectato.com/v1/organization:idis the test organization,caller.scopesthe scopes granted. -
In the test organization, create an order from the test store: the app receives
order.createdat its webhook URL.
In a test organization's app store, the app shows before its publication too, marked "Unpublished"; Install opens its install URL, as for a merchant.
Versions
Section titled "Versions"A private app's versions are published by its partner with Publish, with no review (private apps); the rest of this section is a public app's.
What a merchant sees or grants is versioned: the name, the icon, the website, the store listing, the requested scopes, the redirect URIs, what the app provides and the install URL. Not versioned, and changed directly: the client secret, webhooks (URL, events, secret) and test organizations.
- An app has at most one published version (reviewed: what merchants see in the store and on the consent screen, what installations run on) and at most one version being worked on.
- The first change on Details or Store listing creates the version being worked on, from the published one. A bar shows where it stands: "Unpublished" (no published version yet), "Published version N", "Unpublished changes", "In review", "Rejected", "Suspended" or "Retired, access ends on <date>".
- Send to review is enabled once the store listing is complete (publishing requirements). Notes for the reviewers are written in the sending dialog (Notes for the review) and only the platform team reads them. While in review the version cannot change, and the published version stays in the store.
- Approved, the version becomes the published one; the previous one stays in the history. Rejected, it stays in the history as "Rejected", with the reason; the first change after the rejection opens the next version (N+1), starting from the rejected one, and that one is sent to review.
- Discard changes deletes the version being worked on (a rejected one stays in the history) and goes back to the published one; an app with no published version has nothing to go back to.
- In the partner's test organizations the version being worked on applies (the consent screen, the scopes offered, the store page); everywhere else, the published one. The redirect URIs of both versions are accepted.
- The history shows every version: its number, its state ("Unpublished", "In review", "Published", "Superseded", "Rejected"), what changed, when it was submitted and decided, who on your team submitted it and the rejection's reason.
New scopes
Section titled "New scopes"An approved version asking for more scopes changes no installation: each keeps the scopes it was granted until the merchant approves the new ones, through the consent screen (OAuth). The merchant sees in My applications that the app asks for new permissions ("New permissions to approve"). A version with fewer scopes narrows every installation on publication.
What the app provides
Section titled "What the app provides"Beside the data it reads and writes, an app may work as one of the organization's integrations: a store sending its orders, for example. What the app provides, on Details, lists what the platform lets an app provide; each one:
- needs its scope among the requested ones (saving refuses it otherwise, naming the scope), and that scope is asked only beside it (scopes);
- for a public app, opens the store section of that kind of integration to the app, and then the app must be listed there, as its primary or its secondary section;
- asks whoever installs the app for one more permission in the organization (managing integrations, for a store), beside managing the API; the consent screen lists what the app adds to the organization.
The list is hidden while the platform offers nothing to provide. What an app provides is versioned like the rest, and reviewed for a public app.
The store listing
Section titled "The store listing"Public apps only. The Store listing tab describes the app in the merchants' app store, in Romanian, in English or in both:
- the icon and the name in the store;
- the app's website (optional), shown beside "Developed by <partner>";
- a one-line pitch (on the card) and the full description;
- 3 to 5 key features;
- 3 to 5 screenshots (PNG, JPEG or WebP, at most 5 MB, at least 1280×720) and, optionally, a video link (YouTube or Vimeo);
- the store sections it is listed in: a primary one and, optionally, a secondary one, among ERP; marketing; reports; customer service; other. The sections of our integration categories (stores, couriers, invoicing, email, SMS) take only an app that provides that kind of integration (what the app provides);
- the support and privacy URLs;
- the install URL: absolute,
https(httponly for localhost); the store's Install button sends merchants there; - the app's languages.
To see the listing as a merchant does, open the app store in one of your test organizations: an unpublished app is listed there. On the store page and on the consent screen, the merchant also reads "Developed by <partner>" with the listing's website, "Verified by Connectato" with the date of the published version, and each scope explained in one sentence.
Review
Section titled "Review"The platform team reviews each submitted version of a public app; a private app is never reviewed. What is checked: publishing requirements. The decision, approval or rejection with its reason, is emailed to the partner's contact address.
Retiring and deleting
Section titled "Retiring and deleting"Deleting (the Delete the app button, any member, with the password confirmed) is for an app no merchant uses: it is possible only while the app has no live installation outside the test organizations. Test installations are revoked, the client and its tokens revoked, and the history is kept.
Retiring (the Retire the app button, the owner or an admin, with the password confirmed) is for an app merchants use:
- at once: the app leaves the store and can no longer be installed, and every merchant who has it receives an email with the closing date;
- after 30 days: every installation is revoked (for each, the app receives
app.uninstalledif it receives webhooks) and the app is deleted; - until then, Cancel the retirement undoes it; the app goes back to the store if its published version is still valid.
Suspension
Section titled "Suspension"The platform team may suspend an app, with a reason. At once: its tokens are refused, it leaves the store, it can no longer be installed and its webhooks stop. The partner and the merchants who have it receive an email with the reason. Installations are kept, so lifting the suspension restores access. In the portal, the app shows "Suspended" with the reason, and no version can be submitted for review.