Add-ons - Testing

Testing add-ons occurs in two phases:

  • 1/ Testing by the agency (during development and before submission for approval)
  • 2 /Testing by Upgates (after submission for approval)

Testing by the Agency

What should you test on your side before submitting the add-on for approval? If you are unsure how to properly create/test the add-on at any stage of development, do not hesitate to contact our technical support. It is always better to discuss a specific issue together than to redo the entire add-on later.

  • Activation
    • Thoroughly test the activation of the add-on on your development project.
      • In the Settings / Basic Information section, set everything necessary, including billing information, which is sent in /owner.
      • Then try to activate the add-on.
        • If the add-on cannot be activated and you do not know what to do, contact technical support.
  • Opening
    • After activation, the add-on should:
      • Correctly identify the user and the project that activates it.
        • Offer the user an Iframe, which includes:
        • A thank you message for activating the add-on.
        • Action buttons.
        • If your registration process requires approval:
          • Display a step-by-step process informing the customer of the steps they will go through.
          • Ideally, also show the status of each step (Done - Waiting).
        • If your process does not require approval:
          • Offer buttons:
            • Existing Customer:
              Redirects the customer to the login page of your website. The URL should include a hash, preferably a token, to help identify the Upgates client and automatically pair your user environment with the e-shop after login.
            • Example: https://www.domain.com/login?token=
            • New Customer: Redirects the customer to the registration form on your website. Again, add a hash to the URL. After registration, your environment should be paired with the client's e-shop.
        • Contact details for your support (Email, Phone, Operating hours).
  • Functionality

    Testing the functionality of the add-on is always very individual and depends on what exactly your add-on does. Keep in mind that Upgates' testing capacity is not dedicated to testing your internal functions (whether your environment sends emails correctly, whether some automations work, etc.). You must have all this tested on your side.

    An important aspect on your side is to ensure proper activation, proper opening of the iframe, proper pairing of the customer, and proper functioning of the individual features you provide to the customer through your website.

    Note: The pairing process and overall functionality need to consider that Upgates is multilingual and multi-domain.


    This means that a client's e-shop may have one administration but multiple languages or domains. The data sent to you includes content in all languages (if the client has them set up). If your environment requires language mutation data to be separated, you need to handle this on your side and separate the data from the API communication accordingly. Please do not use the GET parameter ?language unless it is necessary; primarily use one query and separate it according to the required mutations.

What We Need from You:

During our testing, we will test the add-on as a regular customer. Before submitting:

  • Check that the URLs in the Add-on Information are correct and do not lead to a 404 error.

  • Check that the guide for the client on how to activate and connect the add-on with your environment is correctly described.

Once you decide that the add-on is fully ready for launch, send it to us for approval. PS: If you developed the add-on on dev endpoints, please remember to change them back to production so we can test the add-on as a regular customer in a real environment. You can submit for approval from the add-on details in Marketplace / My Add-ons - Your Add-on Name / Main - Submit for Approval.

Testink by Upgates

During our testing, we address:

  • Marketplace
    • Add-on Information:
      • Correctness of the public information about the add-on (Name, logo, favicon, Description, Manual).
      • Functionality of the URLs you provided.
      • Correctly chosen add-on category.
      • Correctly selected Services and Features.

Add-on Development

  • Correctness of the API Endpoints provided.
  • Correctness of the API accesses provided.
  • Checking if you have endpoints that are not related to the add-on's functionality.
  • Ensuring that the API accesses are correctly described, including the correct call frequencies.
  • Administration
    • Add-on Activation:
      • During this testing point, we may ask you to activate a higher tariff on our test account to prevent the account from expiring/allow access to all settings that the client may have.
    • Display of the iframe and its user-friendliness.
    • Deactivation of the add-on.
      • Along with reactivation of the add-on and pairing with an already existing account.
  • Functionality
    • Correctness of API calls (Best Practices).
    • Checking your environment to ensure it does not contain information about the API e-shop login and password.
    • Ensuring it does not contain action buttons (or other elements) that can repeatedly call the API and download things, even if they were previously downloaded, for example, within a few seconds.
Next article
Add-ons - Add-on Development (Technical Documentation)