Add-ons - Iframe

What is Upgates Iframe?

An iframe is an environment for the customer in which they can learn more basic information about the add-on after its activation.
Most often, the add-on offers the customer the opportunity to create a new account / log in using an existing account, or the individual steps that will now follow are listed in the iframe.

Is an iframe mandatory?

An iframe is not mandatory if the login / registration process is a single button and the customer does not have to deal with anything.
So the client clicks Activate add-on and the add-on itself performs registration/login in the background and directly connects the integration without any intervention from the client or the need to fill out forms.

Examples of types of add-ons for which an iframe is mandatory:

We recommend that all add-ons that have not found their integration method in the list below contact Upgates and discuss the necessity of the iframe at the beginning of the add-on creation so that you do not have to deal with changing the activation process during the approval process.

• If your system, despite all optimizations, cannot perform registration with a button and the customer must fill in certain details.
  • The add-on requires certain details to be completed after registration.
    Example: The Ecomail add-on is an emailing tool that works with customers. To avoid the customer overwriting data that they may already have in Ecomail, they offer an "intermediate step" immediately after synchronization, in which they offer which contact list the client wants to import their customers into so that they do not accidentally overwrite an existing contact list. For this type of additional synchronization setting, we allow this part not to be solved via Iframe, but it must be "forced" immediately after opening the external administration.
    
  • "Bridge" type add-on (the add-on is only an intermediary, and only connects Upgates and a 3rd party)
    Example: The Kros Invoicing add-on is created by an external agency that offers a solution for connecting Upgates and the Kros accounting system. However, to make this possible, they need to know from the client their API access to Kros. So they solved it elegantly with an iframe, which guides the customer step by step through the entire process and in the iframe itself they give the option to copy the given codes.
    (you can try it on your project / demo version)
    
  • Add-on that has an approval process
    If your add-on does not allow direct registration to your environment, but the account is approved in some way (requires signing a contract, etc.), it is necessary that the iframe contains an accurate summary of the steps that the given activation goes through so that the customer is always informed about the status of his add-on and the registration request.
    

What should the iframe contain?

• Thank you for activating the add-on.
• The content that you want to convey to the client.
• Contact information for your support.

What should the iframe look like?

In order to offer clients the simplest possible activation process, we make sure that the iframe always has a clear environment. Please avoid unnecessary complexities and complicated solutions that could confuse the client.