#
1. App Creation
#
Introduction
Welcome to Integrator Studio (I.S.), a centralized platform in version 1 of our API documentation designed to streamline the app integration process for a seamless merchant experience.
With the new "App" concept, merchants no longer need to manage API keys or complex configurations. Instead, they can easily browse the app marketplace, select an app, and complete installation with pre-configured settings — all without technical obstacles.
The Integrator Studio (I.S.) dashboard empowers you to manage, test, and deploy your apps in a structured, secure, and efficient manner. From app creation to monitoring and deployment, I.S. offers all the tools needed to handle every stage of the app lifecycle within Armada Delivery Solution.
The Integrator Studio also eliminates the need for sandbox, staging, and production environments. Everything happens in production, with testing occurring through developer accounts — special merchant accounts with limited permissions. This setup allows you to install and test your apps before going live, without needing to switch between environments, ensuring a smoother workflow.
#
Sign Up and Sign In
To access Integrator Studio, you'll need to create an account or sign in using your credentials. Simply Sign Up to get started.
#
Create App
When creating a new app in Integrator Studio, you'll need to fill in several essential fields to configure your integration.
#
Basic Information
- App Name: Provide a unique and descriptive name for your app
- App Icon: Upload an icon that will represent your app in the marketplace
- App Install URL: URL where merchants will be redirected for installation and verification (details on the next page)
- Callback URL: URL for the 2nd part of the installation process (details on the next page)
- Uninstall URL: URL for the webhook that notifies you when a merchant uninstalls the app. See App Uninstalled Webhook
Here's an example of the app creation screen:
#
Webhook Subscriptions & Permissions
Your app needs to specify which webhooks it wants to subscribe to and what permissions it requires to function properly.
Merchants can see what permissions your app requests before installation
#
App Inputs (Optional)
You can configure custom input fields that merchants will fill out during installation. This is useful for collecting configuration data specific to each merchant.
These inputs will be sent to your callback URL during the installation process, allowing you to store merchant-specific configuration. See Callback Pre-Required Inputs
#
Development Cycle
The development and release of an app within Integrator Studio (I.S.) follow a structured cycle, progressing through multiple phases to ensure quality and compliance. Each phase defines the app's availability, editability, and visibility in the marketplace.
#
Main Release Flow
graph LR
A[Development] -->|Submit for Review| B[In Review]
B -->|Approved| C[Production]
B -->|Rejected| A
#
Production Management
graph LR
A[Production] -->|Deactivate| B[Deactivated]
B -->|Reactivate| A
A -->|Downgrade| C[Development]
C -->|Submit for Review| D[In Review]
#
Suspension Flow (Armada Action)
graph LR
A[Production] -->|Armada Suspends| B[Suspended]
B -->|Downgrade & Fix| C[Development]
C -->|Submit for Review| D[In Review]Development (Default Starting Point)
When you create a new app, it starts in Development status by default. The app is published in a development environment where it remains fully editable and can be tested with developer accounts. This phase allows for functional testing and refinement before submitting for review.In Review
Once development is complete, the integrator can submit the app for review. At this stage, the app is locked for editing and undergoes a thorough review by Armada to ensure it meets all platform requirements for production.- If Approved: The app moves to Production
- If Rejected: The app returns to Development for fixes
Production
The app is fully published and available in the marketplace. Merchants can browse, install, and use the app for real-world operations. From Production, integrators have several options:- Deactivate: Temporarily disable the app (can be reactivated back to Production anytime)
- Downgrade to Development: Move back to Development if major changes are needed (requires going through In Review again to return to Production)
Deactivated
A temporary state where the app remains in production but is deactivated by the integrator. Users cannot access or install it until the integrator reactivates it back to Production.Suspended (Armada Only)
If Armada identifies that an app is unstable, has critical issues, or violates platform policies, Armada has the authority to suspend the app. During suspension, the app is inaccessible to users. The integrator can only downgrade the app to Development to fix the issues, then must submit it for review again to return to Production.