Before your application can be published on the App Marketplace, the Square Partner Quality team verifies that your application meets API usage requirements and usability testing. To ensure that your submission can be tested with minimal friction, you need to submit a screen capture video that shows how to navigate through your application to access the points where you're integrating with Square.
You'll learn about the guidelines for producing the video, including required content, video and audio quality, and voice-over requirements.
The Partner Quality team uses your submitted video to understand how to navigate and test your application. Your video doesn't need to demonstrate all application navigation. Instead, you'll walk the viewer from signing in through running the Square integration points.
The team might leave comments or feedback on the video that you need to address. In some cases, you might be asked to re-record your video and provide an updated URL to access the new video.
You need to avoid using the video to pitch the value of your application. The video should only be a replacement for basic seller instructions to use the integration feature.
Follow these guidelines about video format, capture tools, length, feedback, and content that you shouldn't have in your video:
- Video format - Submit your video using a streaming service such as YouTube, Loom, or Vimeo. Your video doesn't need to be public. Just provide a sharable link to your video. If you password protect your video, you should provide a password when you submit your video URL. Regardless of which tool you use, your video resolution must be 1080p or higher.
- Video capture tools - For Mac, you can use Quicktime Player or iMovie. For Windows, follow these Microsoft guidelines to capture screen video. You can also use browser or mobile capture tools such as Vimeo to record and host your video. The tool must let you record audio as you narrate your application.
- Video length - Your video should be about 2 minutes for the introduction and OAuth portion and up to 2 minutes per integration point. An application with one integration point should result in a 2–5 minute video.
- Video feedback - If the Partner Quality team has feedback, comments, or follow-up questions regarding your video, they will only make them available in the Developer Dashboard. Even if you're using a streaming service that allows comments, Square doesn't provide feedback there.
- Video content to avoid - Your video shouldn't include marketing content. Instead, it must be a walkthrough of your application. Don't show real customer information, actual accounts, or real credit card information. Don't showcase features unrelated to the Square integration unless these features are needed to fully set up an account on your platform.
Your video should be scripted and recorded with the following structure:
The introduction is an overview of what your application does and its features. This can be a few sentences at the start of your video. You can speak over your application's home page. There are no extra visual elements needed here. The recommended length is 30 seconds.
Your narration should also include these elements:
A high-level view of how your application integrates with Square. For example:
- "My application uses Square web payments to process payments."
Name the Square APIs used in your integration. For example:
- "We use the Web Payments SDK and Payments API to process payments."
What is the use case of your Square integration? For example:
- "We have an application that lets sellers collect payments with Square through our platform, both online using the Web Payments SDK and in-store using the Terminal API. We create orders, payments, and customer records in Square for each transaction."
Show how a first time user can onboard to your application. The recommended length is 1–2 minutes.
Include the following:
- How a seller signs in to your platform and where in your application they connect with Square and accept OAuth permissions.
- How to set up an account in your system and how to connect your application to Square. Include setup instructions such as how to complete a profile or create a product and any additional required onboarding steps that are specific to your application.
What is the experience of sellers who use your application's integration with Square? The video should show how sellers use your application to perform the actions that directly integrate with Square. The recommended length is 1–2 minutes per integration use case.
For example:
- For payment and orders integration, show that flow in your application and display the resulting transaction and order in the Seller Dashboard.
- For importing a seller's Square Item Library, show your application interface that a seller starts a catalog sync and then view their imported items.
- For syncing customer records between your application and Square, show your application interface that a seller uses to start a customer sync and then view their imported customers.