Allmänt

För att aktivera en app som datakälla slår du på reglaget Datakälla under Ramverk. Fortsätt sedan att konfigurera appen enligt dokumentationen nedan. Ett fullständigt exempel på hur config kan se ut finns i figur 1. För allmän appkonfiguration, t.ex. fält som användarna konfigurerar själva, se dokumentationen för Upsales-appar.

Upsales skickar varje anrop till din app som en POST med en JSON-body, och appens endpoint måste använda HTTPS. Appen har 30 sekunder på sig att svara.

Config för capabilities

Följande fält kan konfigureras under capabilities. Din app visas i modalen för att lägga till nytt företag bara om capabilities.typeahead är satt, och i dialogen för att uppdatera/koppla företag bara om capabilities.refresh är satt.

Tabell 1

Egenskaper för config-objektet capabilities

Tabell 2

Egenskaper för ett prisalternativ

Config för typeahead

Det här är konfigurationen för modalen för att lägga till nytt företag. Varje sökning skickas till din app som ett filter på name, eller på orgNo när söktexten ser ut som ett organisationsnummer. Följande fält kan konfigureras under typeahead:

Tabell 3

Egenskaper för config-objektet typeahead 

Tabell 4

Egenskaper för config-objektet pagination

Tabell 5

Egenskaper för config-objektet countryTabs 

Kolumner

Följande attribut kan konfigureras för kolumner 

Tabell 6

Egenskaper för ett config-objekt av typen Column  

Tabell 7

De olika kolumntyperna 

Config för refresh 

Det här är inställningarna för knappen för att uppdatera/koppla företag i företagsvyn. Följande fält kan konfigureras under refresh:

Konfiguration av iFrame

För att visa din app i en iframe på företagskortet sätter du iframe=true i den yttersta nivån av config. Appens ikon visas bredvid namnet. När en användare öppnar appen på ett företag skickar Upsales ett POST-anrop till din app på /iframe med företaget under body.data (dess id är body.data.id). Svara med URL:en till sidan som ska visas i iframen.

Exempel

Figur 1. Ett exempel på config för en datakälla-app

{
    "fields": {
        "account": [
            {
                "type": "multiselect",
                "name": "countries",
                "label": "Countries",
                "required": true,
                "externalValues": true
            },
            {
                "type": "checkbox",
                "name": "createContacts",
                "label": "Create contacts"
            }
        ],
        "user": [],
        "test": true
    },
    "uiElements": {
        "account": {
            "sidebar": [
                {
                    "name": "monitoring",
                    "type": "iframe"
                }
            ]
        }
    },
    "requirements": [],
    "capabilities": {
        "logo": "https://img.upsales.com/app/102/logo.png",
        "match": {
            "upsales": "dunsNo",
            "integration": "dunsNo"
        },
        "pricing": {
            "buy": {
                "endpoint": "buy",
                "cost": 0,
                "text": {
                    "en": "Basic data",
                    "sv": "Basdata"
                }
            }
        },
        "typeahead": {
            "idField": "dunsNo",
            "pagination": {
                "enabled": true
            },
            "countryTabs": {
                "enabled": false
            },
            "columns": [
                {
                    "type": "string",
                    "header": "Company name",
                    "field": "name",
                    "width": "70%"
                },
                {
                    "type": "add",
                    "width": "30%"
                }
            ]
        },
        "refresh": {
            "columns": [
                {
                    "type": "string",
                    "header": "Company name",
                    "field": "name",
                    "width": "70%"
                },
                {
                    "type": "add",
                    "width": "30%"
                }
            ]
        }
    },
    "iframe": true
}