Person import - Sympa API

Hakemalla henkilötietoja Sympa API:sta saadaan henkilötiedot päivitettyä Neptoniin useita kertoja päivässä. Sympa API:sta voidaan hakea myös tiedot tulevista henkilötietojen muutoksista etukäteen.

Lisätietoa: Tietojen voimassaolot henkilötuonneissa

Käyttöönotto

Henkilötietojen siirto Sympan APIa hyödyntäen otetaan käyttöön määrittelemällä Sympaan tuotavan tiedon poimintasäännöt ja Neptoniin henkilötietojen noudon ajastus. Sympan poimintasäännöt määrittelee Sympan-asiantuntija vakioidulla tavalla. Henkilötietojen noudon ajastuksen voit tehdä seuraavilla ohjeilla.

Ajastuksen määritys

Käytä ajastetun tehtävän määrityksessä seuraavia valintoja. Lisäohjeet ajastettujen tehtävien lisäämisestä täältä.

• Merkistökoodaus: UTF-8
• Tiedoston tyyppi: JSON
• Henkilötuonnin tyyppi: Sympa HR Integraatio API
• Autentikaatiotyyppi: Perus HTTP-autentikointi
• REST API osoite: Sympan antama osoite
• Parametri 1: Käyttäjätunnus - Nimi: "username", Arvo: "SympaltaSaamanneKäyttäjätunnus"
• Parametri 2: Salasana - Nimi: "password", Arvo: "SympaltaSaamanneSalasana"
• Ajastus: Suosittelemme kerran päivässä klo 00:15 - 01:00 välillä.

Siirrettävän tietomäärän rajoittaminen

Kun liittymä otetaan käyttöön niin on mahdollista siirtää osa henkilötiedoista ensin. Tällä voidaan varmistua siirrettävän sisällön oikeellisuudesta. Tiedon tuontia voidaan rajata ajastuksen määrityksen yhteydestä löytyvälllä, REST API:n osoitteen parametrilla. Lisäämällä osoitteen perään "?$orderby=Puhelinnumero&$top=20" Sympasta haetaan henkilöt järjestettynä puhelinnumeron mukaan 20 ensimmäistä. Järjestykseen voidaan laittaa muitakin kenttiä, mutta merkityksellistä on tuo top-parametri, jolla voidaan rajata vain 20 henkilöä siirtymään kerralla. Näitä parametreja voi vaihtaa liittymän testauksessa.

Kentät ja kenttäryhmät

Henkilötietojen tuonnissa voi käyttää kaikkia yleisen henkilötuonnin kenttiä. Henkilön lisätietokenttiä tuetaan, kun kentän nimi API:n datassa vastaa kentän nimeä Neptonissa. Lisäksi kentän arvot voidaan siirtää voimassaolotiedoilla, jos kenttä siirretään kenttäryhmän kenttänä ja se tukee voimassaloja. Alla kenttät jotka tukevat kenttäryhmiä.

Vakioitu liittymä

Tämän ohjeen alussa mainitun vakioidun Sympa API liittymän kohdalla, siirretään vakiomutoinen siirtoainesto. Alla vakioidun liittymän siirtoaineston kentät.

Vakioidun liittymän aineistoesimerkki

{
    "@odata.context": "https://api.az-sympa.com/api/$metadata#NeptonKaikkiTiedot",
    "value": [
        {
            "Henkilönumero": "123",
            "Kutsumanimi": "Erkki",
            "Etunimet": "Erkki Esko Eemeli",
            "Sähköposti": "maili@maili.com",
            "Puhelinnumero": "040 456 7890",
            "Ensisijainen esimies": "Esimerkki",
            "IBAN": "FI0453260051234567",
            "Katuosoite": "Katu 1",
            "Postinumero": "00000",
            "Postitoimipaikka": "Turku",
            "RFID-tunniste": "ABCDE123456",
            "Yksiköt": "Tuotekehitys",
            "Rooli": "Työntekijä",
            "Työajan roolit": "Työntekijät",
            "Käyttäjätili käytössä": "Kyllä",
            "_FilterLiiketoimintayksikko": "3",
            "_TESTUSER": false,
            "Työsuhde_TAULUKKO": [
                {
                    "Voimassa alkaen": "2020-06-02",
                    "Voimassa päättyen": "2020-10-13",
                    "Ammattinimike": "Testaaja",
                    "Työaika prosentteina": 80.0,
                    "Työajan asetusryhmä": "1234"
                },
                {
                    "Voimassa alkaen": "2020-10-14",
                    "Voimassa päättyen": null,
                    "Ammattinimike": "Ohjelmistokehittäjä",
                    "Työaika prosentteina": 100.0,
                    "Työajan asetusryhmä": "2456"
                }
            ],
            "Kustannuspaikka_TAULUKKO": [
                {
                    "Voimassa alkaen": "2020-06-02",
                    "Voimassa päättyen": null,
                    "Oletuskustannuspaikka": "103"
                    "Toimipiste": "Kamppi"
                }
            ],
            "Organisaatio_TAULUKKO": [
                {
                    "Voimassa alkaen": "2020-06-02",
                    "Voimassa päättyen": null,
                    "Organisaatiotaso1Nimi": "Ohjelmistotalo Oy",
                    "Organisaatiotaso2Nimi": "Turku",
                    "Organisaatiotaso3Nimi": "Tuotekehitys",
                    "Organisaatiotaso1Koodi": "10",
                    "Organisaatiotaso2Koodi": "120",
                    "Organisaatiotaso3Koodi": "1500"
                }
            ],
            "Toissijaiset_esimiehet_TAULUKKO": [
                {
                    "Voimassa alkaen": "2020-09-15",
                    "Voimassa päättyen": "2022-01-01",
                    "Toissijaiset esimiehet": "1234"
                },
                {
                    "Voimassa alkaen": "2016-01-01",
                    "Voimassa päättyen": null,
                    "Toissijaiset esimiehet": "4321"
                }
            ],
            "Asetusryhmä_TAULUKKO": [
                {
                    "Voimassa alkaen": "2020-06-02",
                    "Voimassa päättyen": null,
                    "Työajan asetusryhmä": "Liukuva työaika"
                }
            ]         }
    ]
}

Kenttien arvojen tuonti ilman voimassaolotietoja

Mikäli siirrettävässä aineistossa ei määritellä tiedon voimassaoloja niin tuotava tieto käsitellään ilman voimassaoloja. Alla ainestoesimerkki siirrosta ilman voimassaolotietojen tuontia.

{
    "@odata.context": "https://api.az-sympa.com/api/$metadata#NeptonKaikkiTiedot",
    "value": [
        {
            "Henkilönumero": "123",
            "Käyttäjätunnus": "esko.esimerkki@yritys.fi",
            "Sukunimi": "Esimerkki",
            "Etunimi": "Esko",
            "Sähköposti": "esko.esimerkki@yritys.fi",
            "Ensisijainen esimies": "21",
            "Käyttäjätili käytössä": "Kyllä"
        }
    ]
}

Kenttien arvojen tuonti voimassaolotiedoilla

Sympa API henkilötuonti tukee voimassaolojen siirtämistä osalle kentistä. Kun voimassaoloja tukeva kenttä, siirretään kenttäryhmän kenttänä, voidaan sille määritellä voimassaolot kenttäryhmän tiedoissa.

Tiedon tuonnissa kentät saavat voimassaolon kenttäryhmän 'Voimassa alkaen' ja 'Voimassa päättyen' kenttien mukaan. Katso lisätiedot voimassaolotietojen siirrosta täältä. Voimassaolovälit siirretään kenttäryhmien riveinä. Kenttäryhmän kentät voidaan myös halutessa, tuoda ilman voimassaolotietoja. Mikäli kenttäryhmä siirretään tyhjänä ilman yhtäkään riviä, kenttäryhmän kaikkien kenttien kaikki arvot poistetaan Neptonista. Alla ainestoesimerkki siirrosta voimassaolotiedoilla kenttäryhmän avulla.

{
    "@odata.context": "https://api.az-sympa.com/api/$metadata#NeptonKaikkiTiedot",
    "value": [
        {
            "Henkilönumero": "123",
            "Sukunimi": "Esimerkki",
            "Etunimi": "Esko",
            "Työsuhde_TAULUKKO": [
                {
                    "Voimassa alkaen": "2020-06-02",
                    "Voimassa päättyen": "2020-10-13",
                    "Ammattinimike": "Myyjä",
                    "Työaika prosentteina": 80.0,
                    "Työajan asetusryhmä": "1234"
                },
                {
                    "Voimassa alkaen": "2020-10-14",
                    "Voimassa päättyen": null,
                    "Ammattinimike": "Myyntipäällikkö",
                    "Työaika prosentteina": 100.0,
                    "Työajan asetusryhmä": "2456"
                }
            ]
        }
    ]
}

Lisätietoja tuonnista

Nepton hakee henkilötiedot kutsumalla Sympa API:a. Sympa palauttaa henkilötiedot JSON-muodossa, noudattaen sisällön rakenteen osalta OData Versio 4 standardia. Tiedon poiminnan sisältö ja hakurajaukset määritellään Sympan käyttöliittymässä.