======  How do I create an interface? ======

For a newsletter, new addresses are generally obtained automatically, e.g., via the company website. When using REST, you will find the interfaces under //Addresses > Interfaces//.


==== Creation of an interface ====

Via //Addresses > Interfaces//, you can create a new interface with this button:

{{:en:addresses_interfaces_button.png?nolink&150|}}


The following window opens via //Create interface//, in which you assign a name, select the channel (E-mail, App Push, SMS, Print, Web Push, Voice), the opt-in type (Double opt-in, Single opt-in), and configure hooks. You can also enter a URL for redirects.

{{:en:addresses_interfaces.png?nolink&600|}} \\ Now the interface has been created and provided with an ID.

==== Menu item Sheet ====

=== Configure hooks ===


Under //Add hook//, you can define which //Action// should be carried out with the generated address. First, choose between the following actions: \\
\\
{{:en:addresses_interfaces_hook.png?nolink&250|}}

Now select a target group for which the action is to be carried out under //List//.

=== Insert URL for redirects ===


After a successful or failed login, you can be redirected to any page. To do this, enter a URL, e.g., a confirmation page on your company website.

You can specify a URL, including a protocol for forwarding, if the login was successful. Appending parameters is possible to personalize the landing page. You can also enter a URL, including a log for forwarding, in the event of a failed login.


=== Copy interfaces ===

At the top right of the interface, you have the option of copying the created interface with all the associated settings.

{{:de:addresses_interfaces_copy.png?nolink&100|}}

==== Menu item Log ====

Here you will find a list of user actions:

| Created | Timestamp when the user performed the action |
| Action | registration or confirmation of the registration |
| Process | Code that establishes the connection between registration and confirmation |
| IP address | IP address of the user |
| User ID | User ID of the user |
| Message | Comment entered via API (optional) |

==== Menu item Statistics ====

Above you will find the following two statistics:

Registrations: Number of registered logins. In the case of double opt-in procedures, regardless of whether the registration was confirmed by double opt-in. \\
Confirmations: Number of registered registrations whose e-mail address was not included in the master data before registration.

Below you will find the openings and clicks on the DOI Mail.

{{:en:addresses_interfaces_statistics.png?nolink&900|}}


==== Menu item DOI campaign ====

This tab only appears if //Email// was selected as the channel and //Double Opt-In// was selected as the opt-in type.

You can create one or more messages. The message that is to be used for the DOI Mail must be activated.

The available messages are displayed in a list. (Maximum) one message is active. The active one is used for delivery. It cannot be edited. To change the active message, you can copy it and edit the copy or create a new one. Activating the message created in this way will deactivate the previously active message.

=== Creating a double opt-in email  ===

Don't forget to configure sender and subject too!

You can use $confirmToken, which contains the opt-in confirmation token. This token can be used to confirm an opt-in via REST API. This placeholder is not replaced in the preview of this mail and is only available when the double opt-in mail is actually sent.

Example URL:
<nowiki>https://foo.bar.com/?token=$confirmToken</nowiki>


If you want to use our system and still want to use a replaced URL for tracking you can use this URL: 
<nowiki>https://system.promio-connect.com/optin/?token=$confirmToken</nowiki>

==== Menu item Form ====

<WRAP round tip 80%>
The form creation is only possible in clients with the mail-unique identification feature (not for custID-unique). It is only available for the “E-Mail” channel.
</WRAP>

Under this menu item, you can configure a form for address generation that you can embed on a website or call up as a stand-alone page.

=== Content tab ===

In the //Content// tab, you can select the fields that your form should contain.

{{:en:addresses_interfaces_formular_content.png?nolink&400|}}

<WRAP round info 80%>
The E-Mail and "Send" button fields cannot be removed, but you can change the label.

A recipient field cannot be added to a form more than once.

</WRAP>

== Field of type "Newsletter" ==

The same newsletter can be selected as often as you like.

Validation is not possible in the preview.

=== Confirmation page tab ===

Here you can enter and format text that should be displayed after the completed form has been submitted.

{{:en:addresses_interfaces_formular_confirm.png?nolink&400|}}

<WRAP round info 80%>
Our system does not support placeholders on the confirmation page, e.g., for a personalized greeting.
</WRAP>

=== Design tab ===

Set the font, font size, font color, and primary color of the button. You can optionally insert a custom CSS.

{{:en:addresses_interfaces_formular_design.png?nolink&400|}}

=== General tab ===

Select a language. To use a separate page for the form, enter an image path and an imprint link.

{{:en:addresses_interfaces_formular_general.png?nolink&400|}}

<WRAP round info 80%>
Click Publish to initially publish the form so that it is available. Publish changes to make them visible on the page.
</WRAP>

=== Preview tab ===

Here you can see the preview of the created form.

{{:en:addresses_interfaces_formular_preview.png?nolink&400|}}

=== Usage tab ===

Copy the code of the created form to embed it on a web page or copy the code for a stand-alone page.

{{:en:addresses_interfaces_formular_usage.png?nolink&400|}}



{{tag>addresses form interfaces hooks auto_target_groups address_generations subscribers registrations registration_pages DOI REST API }}