Externals

Disclaimer: This is a feature flag, and needs to be enabled at the Organisation level.

The “Externals” feature is used as a gateway to populate databases, either by retrieving data from an external site into Electa or by posting data from Electa to another site. Essentially, this feature enables external API calls for authentication and vote registration.

To set up an external endpoint, start by going to the “Externals” tab, which can be found on the left-hand menu. Afterwards, click on the “+” button on the top right corner, followed by “External endpoint”.

Open

• URL: This field defines the URL of the endpoint, ie. the external site to which the data is retrieved from or posted to.

• Purpose: This specifies the purpose of the endpoint, which can either be to verify the eligibility of voters (“eligibility”) or to access statistics on the votes (“report_voted”).

• Method: This specifies the method that should be used when calling the endpoint. That means whether the action should be to retrieve data (“GET”) or to post data (“POST”).

• Framework: This field allows you to select the HTTP framework (either “net_http” or “async_http”) that should be used when calling the endpoint.

• Activated: When this field is toggled, that means that the endpoint is enabled. Otherwise, if left untoggled, the endpoint will not be active.

Open

After setting up all the necessary and relevant fields, click “Create External endpoint” to finalize the process. This will then redirect you to a new page. In this page, there are three additional features, which correspond to the different types of information you can retrieve in the API.

Open