Skip to main content

Import kontaktów

Metody pozwalają na zaimportowanie oraz zarządzanie wykonanymi importami kontaktów do TeleCube CRM. Import może zostać wykonany zarówno do kategorii osób jak i organizacji, każdorazowo osobnym zleceniem.

1. Pobranie listy wykonanych importów

Metoda umożliwia pobranie listy uprzednio wykonanych importów.

Metoda: GET
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/importData

Metoda stosuje stronicowanie powyżej 1000 rekordów. API zwróci zawsze maksymalnie 1000 rekordów, a o resztę należy zapytać dodając do adresu page={numer_strony}. Przykładowo, dla sytuacji gdzie jest więcej niż 1000 rekordów stosujemy:

{twoja_nazwa}.ccrm.pl/publicApi/importData?page=2

Struktura odpowiedzi

Właściwość

Wartość

Opis

uuid

uuid

Wartość identyfikująca plik.

fileName

string

Nazwa pliku.

from

string

Źródło danych.

resource

string

Importowany zasób.

created

datetime

Data i godzina.

message

string


Przykład odpowiedzi 
{
    "success":true,
    "data":[
        {
            "uuid":"f42f4011-7bb7-4624-a039-2417a53caec9",
            "fileName":"Import.csv",
            "status":"rollbackFinish",
            "from":"file",
            "resource":"people",
            "created":"2022-12-29 15:24:42"
        },
        {
            "uuid":"215113ce-d19e-4cd0-b250-8111f00bdb7e",
            "fileName":"people.csv",
            "status":"finish",
            "from":"file",
            "resource":"people",
            "created":"2022-10-25 11:27:50"
        },
        {
            "uuid":"ab205d0e-3e59-4cc5-b8da-1462cba88622",
            "fileName":"exportPerson-2022-10-24-12 23 38.csv",
            "status":"finish",
            "from":"file",
            "resource":"people",
            "created":"2022-10-25 09:41:15"
        },
    ],
    "otherData":{
        "totalCount":3
    },
    "message":"OK"
}


2. Wykonanie importu

Aby poprawnie wykonać import, należy wykonać poszczególne czynności zgodnie z podaną kolejnością:

  1. Wskazać plik do importu.
  2. Pobrać listę pól możliwych do wykonania mapowania.
  3. Wykonać mapowanie, tj, wskazać powiązanie między polem z pliku a polami z CRM.
  4. Wykonać import.

2.1 Wskazanie pliku do importu

Metoda pozwala na wgranie posiadanego pliku do mechanizmu importu.

Metoda: POST
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/importData/file

Struktura żądania

Właściwość

Obligatoryjne

Wartość

Opis

resource

TAK

in:people,organisation


file

TAK

mimes:json,csv,txt


separator


null |string

Najczęściej “,” lub “;”.

message


string


Przykład żądania 
{
        "resource":"people",
        "file":"{plik}",
        "separator":null
    }

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data.uuid

uuid

Wartość identyfikująca rekord.

data.paramfileName

string

Nazwa pliku.

data.param.mimeType

string

Format danych.

data.mappingColumn

array | null

Lista powiązanych kolumn z pliku z nazwami kolumn w systemie CRM.

data.info.totalCount

int

Ilość rekordów w pliku.

data.dataColumns

array

Kolumny danych z pliku.

data.status

string in: userInteraction, readyToImport, finish, rollbackFinish

Status importu.

data.from

string

Źródło importu.

data.resource

string

Zasób importu.

data.created

datetime

Data wysłania pliku.

otherData.totalCount

int

Ilość stworzonych rekordów.

message

string


Przykład odpowiedzi 
{
    "success":true,
    "data":{
        "uuid":"d2c6d108-a97e-4b7b-ad1a-2b6a5be1f210",
        "param":{
            "fileName":"importFile/bbwrmTAXOeIq417cCoLVLmd2WWdXlX4HG6WZoWHd.txt",
            "mimeType":"text/plain"
        },
        "mappingColumn":null,
        "info":{
            "totalCount":1
        },
        "dataColumns":[
            "Imię",
            "Nazwisko",
            "Miasto"
        ],
        "status":"user_interaction",
        "from":"file",
        "resource":"people",
        "created":"2022-12-29 20:47:36"
    },
    "otherData":{
        "totalCount":1
    },
    "message":"OK"
}


2.2 Pobranie listy pól możliwych do wykonania mapowania

Metoda pozwala na pobranie listy możliwych pól (w tym utworzonych pól własnych dla kontaktów), które w dalszym kroku będzie można powiązać z kolumnami arkusza, aby prawidłowo wskazać powiązanie danych.

Metoda: GET
Adres URL (dla osób): {twoja_nazwa}.ccrm.pl/publicApi/importData/availableFields/people
Adres URL (dla organizacji): {twoja_nazwa}.ccrm.pl/publicApi/importData/availableFields/organisation

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data

array

Lista możliwych pól do mapowania.

otherData

array


message

string


Przykład odpowiedzi 
{
    "success": true,
    "data": [
        "First name",
        "Middle name",
        "Last name",
        "Pesel",
        "Description",
        "Phone 1",
        "Phone 1 Name",
        "Phone 2",
        "Phone 2 Name",
        "Phone 3",
        "Phone 3 Name",
        "Email 1",
        "Email 1 Name",
        "Email 2",
        "Email 2 Name",
        "Email 3",
        "Email 3 Name",
        "Doc type Name",
        "Id Doc Type",
        "Doc number",
        "Doc issuer",
        "Address 1 Name",
        "Address 1 street",
        "Address 1 building no",
        "Address 1 local no",
        "Address 1 postcode",
        "Address 1 city",
        "Address 1 voivodeship",
        "Address 1 country",
        "Address 1 district",
        "Address 2 Name",
        "Address 2 street",
        "Address 2 building no",
        "Address 2 local no",
        "Address 2 postcode",
        "Address 2 city",
        "Address 2 voivodeship",
        "Address 2 country",
        "Address 2 district",
        "Address 3 Name",
        "Address 3 street",
        "Address 3 building no",
        "Address 3 local no",
        "Address 3 postcode",
        "Address 3 city",
        "Address 3 voivodeship",
        "Address 3 country",
        "Address 3 district",
        "Tag",
        "Watcher",
        "Manager",
        "Data zamówienia",
    ],
    "otherData": [],
    "message": "OK"
}


2.3 Wykonanie mapowania

Metoda pozwala na dokonanie mapowania pomiędzy polami dostępnymi w CRM a kolumnami z arkusza. Każda kolumna powinna być powiązana wyłącznie z jednym polem.

Metoda: POST
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/importData/mapping/{uuid}

Struktura żądania

Właściwość

Wartość

Opis

mapping

object

Lista nazw pól z pliku w połączeniu z nazwami systemowymi CRM.
Przykład żądania 
{
    "mapping":{
        "Imię":"First name",
        "Nazwisko":"Last name",
        "Miasto":"Address 1 city"
    }
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

array

otherData

array

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}
": "OK"
}

2.4 Wykonanie importu

Metoda: POST
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/importData/import/{uuid}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

array

otherData

array

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}


3. Wycofanie importu

Metoda pozwala na wycofanie uprzednio wykonanego importu danych.

Metoda: POST
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/importData/rollback/{uuid}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

array

otherData

array

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}

4. Usunięcie pliku importu

Metoda pozwala na usunięcie wcześniej importowanego pliku. Przed wykonaniem tej metody, należy wcześniej wycofać import przy użyciu metody powyżej.

Metoda: DELETE
Adres URL: {twoja_nazwa}.ccrm.pl/publicApi/importData/{uuid}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

array

otherData

array

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}


Back to top