From sandbox to app launch checklist
The following is a step-by-step guide referencing the sandbox and production environments, building and testing apps, and getting your apps approved.
In the sandbox environment
| Step | Task | Description |
|---|---|---|
| 1. | Choose the region to build your app or integration. | - North America: Create a global developer account and access both the sandbox and production environments on the Global Developer Dashboard. —or— - Europe or Latin America: Create your sandbox developer account to access the Developer Dashboard. |
| 2. | Use your sandbox developer account. | Create, test, and manage your apps in the sandbox environment. Clover provides base URLs for different services: - Platform API: https://sandbox.dev.clover.com - Tokenization service API: https://token-sandbox.dev.clover.com - Ecommerce service API: https://scl-sandbox.dev.clover.com |
| 3. | For payment integrations, Create Remote App ID (RAID) in the sandbox environment. | When your integration connects to a Clover device, your application must pass a Remote App ID (remoteApplicationID or RAID) generated for your Clover app. RAID is separate from your Clover App ID, and both IDs are needed to launch your integration with Clover. |
| 4. | Create your test merchant in the sandbox environment. | See the following developer guides for information on building your application: - Clover Android SDK to build Android apps that run on Clover devices. - Clover REST API to build web apps. - Clover Android Payments API to build a native point-of-sale (POS) application directly on a Clover device and to process payments from your Android app on a variety of Clover device configurations. - REST Pay Display API to build a semi-integrated application on a Clover device connected to your POS. - Ecommerce API and iframe to build a standalone or companion payment integration with Ecommerce services tailored to the needs of merchants. |
| 5. | Build and test your app in the sandbox environment. | Your sandbox account is connected to a test payment gateway, which checks the validity of test cards and provides realistic responses to payment requests. You can build apps that interact with Clover's payment functions and allow you to test all possible responses when completing a transaction. To learn more, see Create an app and Manage app settings. |
| 6. | Get an OAuth token. | Clover OAuth 2.0 framework requires you to retrieve an access and refresh token pair before accessing merchant information, such as inventory, orders, and payments. You need to authorize merchants to access your app from the Clover App market when it is in the production environment. When an authorized merchant is redirected to your app with an authorization code, the Clover server uses the code to confirm that your request for merchant data is authorized by the merchant. |
| 7. | Generate an API test token on the test Merchant Dashboard. | Note: An API test token is needed only for testing purposes in the sandbox environment and is not for use in the production environment. Your app uses the confirmed authorization code, client ID, and client secret to request the Clover server for an API token. With the API token, your app can make REST API calls and access merchant data |
In the production environment
You can submit your developer account for approval in the production environment even while you are building and testing your app in the sandbox environment.
| Step | Task | Description |
|---|---|---|
| 1. | Use your production developer account | When you are ready to start building an app for real users, you need an approved production developer account for each country or region in which you want to create apps, depending on your merchant's location: - North America: Global Developer Dashboard - Europe: Developer Dashboard - Latin America: Developer Dashboard The Clover team reviews and approves each developer account you create in the production environment. |
| 2. | Submit your production developer account for approval. | Your app is linked to a production developer account. Before app approval can begin, you must get this account verified and approved by Clover. Click the Dashboard > Developer Settings tab to complete the steps. |
| 3. | Recreate your app in the production environment. | Complete all the required information, including the points of integration with Clover. |
| 4. | Select a region where you want to publish your APIs in the production environment. | In the production environment, Clover provides base links (URLs) for different services in supported markets. If you are using Clover RESTful APIs, select a region as follows: - Platform API (US and Canada): https://api.clover.com - Platform API (Europe): https://api.eu.clover.com - Platform API (LATAM): https://api.la.clover.com - Tokenization service API: https://token.clover.com - Ecommerce service API: https://scl.clover.com |
| 5. | Generate an OAuth and API token for apps on the Clover App Market in production environments. | Use the same steps to get the OAuth code and the API token as in the sandbox environment. Simply replace https://sandbox.dev.clover.com/ with the correct regional base URL in your requests: - US and Canada: https://www.clover.com/ - Europe: https://eu.clover.com/ |
| 6. | Test your app and record payment flow videos for your app submission. | If required, create a release group to test your app on a small group of merchants. - Verify your application can successfully pass the required tests. - Record a video of each payment flow. |
| 7. | Set up billing information. | If you plan to create paid apps, you can update your bank details on the Developer Settings page on your production developer account. For more information, see: - Manage developer bank account information - Clover developer agreement - Handle app billing |
| 8. | Submit an app for approval using your production developer account. | Get your app approved through the following review stages: - Functional review—Clover installs your app and reviews it for functional operability. - Legal & privacy—Clover reviews if the app meets its terms of service and privacy policy. - Market listing—Clover reviews information about your app for Clover merchants to view when published on the Clover App Market. |
| 9. | Launch your app. | - For on-Clover device and online integrations, publish your approved app in the Clover App Market. - For payment integrations, use CoPilot to board merchants and deploy your custom integration. See CoPilot. |
| 10. | Request and receive support as needed. | Maintenance phase starts once your app is approved and in production for use with Clover merchants. |
What's next
Updated 5 months ago