Interface

The interface describes the structure of output bundles and specifies the parameters seen in the mapping modal. It should contain the full response from the API, including nested parameters.

You can generate an interface using our Interface Generator.

Dynamic interface according to user-defined fields

Retrieving all fields from the endpoint could be difficult, especially when integrating an ERP or other business-related backend that has hundreds of fields.

The solution to this varies across different platforms, but they are similar.

One method is to use a select parameter to retrieve only the fields that you need. For example, Open Data Protocol (OData).

Source

GET serviceRoot/Airports?$select=Name,IcaoCode

{
    "@odata.context": "serviceRoot/$metadata#Airports(Name,IcaoCode)",
    "value": [
        {
            "@odata.id": "serviceRoot/Airports('KSFO')",
            "@odata.editLink": "serviceRoot/Airports('KSFO')",
            "Name": "San Francisco International Airport",
            "IcaoCode": "KSFO"
        },
        ......
    ]
}

With Name and IcaoCode as the only output, adjust the interface to indicate to users that only these fields are available for mapping.

Example

Twitter [v6]

Mappable parameters

Source

[
    {
        "name": "tweet_fields",
        "label": "Fields",
        "type": "select",
        "multiple": true,
        "advanced": true,
        "options": [
            {
                "label": "Attachments",
                "value": "attachments"
            },
            {
                "label": "Author ID",
                "value": "author_id"
            },
            {
                "label": "Context Annotations",
                "value": "context_annotations"
            },
            ...
        ]
    },
    ...
]