Hur fungerar &frankly API och tjänst

Ändrad den Tors, 20 mar. vid 6:14 E.M.

Denna tjänst och API-slutpunkt ger kunder möjlighet att ladda upp filer till &frankly för att tillhandahålla användar- och organisationsdata till oss för import till &frankly.

Det finns några alternativ när det gäller vilka fil- och filformat som kan användas, läs mer nedan i avsnittet Olika filformat.

Uppladdningstjänsten är tillgänglig som:

API (REST/HTTPS)
Secure FTP (SFTP)

Värdnamnet/basadressen är densamma för båda slutpunkterna: upload.api.andfrankly.com

Läs mer här: &frankly ladda upp &frankly upload API & service | API Reference

Obs: Detta är inte samma API som &frankly organisations API (&frankly organization API | API Reference)

Filformat

Excel-fil

Tips: När du laddar upp en Excel-fil kan du lägga till användarinformation och gruppinformation i samma fil men på olika ark.

Krav och begränsningar:

Rubrikraden (första raden) bör namnges exakt som det står nedan, annars kommer den kolumnen att hanteras som ett attribut i &uppriktigt sagt.
Om ett fält är tomt kommer uppladdnings-API:et att hoppa över det värdet.
Filtillägg som stöds är: xls, xlsx
Kodningen måste vara UTF-8

Du hittar en exempelfil längst ner i artikeln

Fältbeskrivningar:

Sheet name = Users
Header/Name/First row	Example value	Note
EmployeeID	E123456	Column & value mandatory, must be in column 1
FirstName	Testman	Column & value mandatory, must be in column 2
LastName	Foobar	Column & value mandatory, must be in column 3
Email	Testman.Foobar@com.co	Value optional (If there is a value for PhoneNumber) , Column mandatory (must be on column 4)
PhoneNumber	+00 1234 567	Value optional (if there is a value for Email). Need to have the country code in beginning and correct number format for that country(+46 XXX XXXXXX)
IsManager	1	Optional. Provides role manager to this user.
Department	DEP_001	Optional. Can be repeated if users should be member in more then one group. This is externalid on group.
DepartmentName	Sales team	Optional. Can be repeated if users should be member in more then one group. This is name on group. Will not be used if Department is set.
EmployeeManagerID	E654321	Optional. The externalid on the manager.This will add this user as manager on groups that this person is member of.
EmployeeManagerName	foo barsson	Optional. The externalid on the manager.This will add this user as manager on groups that this person is member of. Will not be used if ManagerID is set.
Active	0	Optional. If empty it will leave user at is current state. Values: 1 / 0
Language	sv	Optional (BCP47)

Sheetname = Groups
Header/Name/First row	Example value	Note
OrgUnitID	DEP_001	Column & value mandatory, must be in column 1
Name	HR	Column & value mandatory, must be in column 2
Description	HR Department	Column mandatory, value optional, must be in column 3
ResponsibleManager	E654321	Column mandatory, value optional, must be in column 4. The externalid on manager. This will add this user as manager on this group
ParentOrgUnit	DEP_002	Column mandatory, value optional, must be in column 5. The OrgUnitID of the parent group (if not set will then be top/root group).

Csv User file

Krav och begränsningar:

Rubrikraden (första raden) är namnet exakt som det står nedan, annars kommer kolumnen att hanteras som ett attribut i &frankly.
Om ett fält är tomt kommer uppladdnings-API:et att hoppa över det värdet.
Format som stöds är: csv-filer separerade med ; (semikolon) eller | (rör).
Kodningen måste vara UTF-8

Du hittar en exempelfil längst ner i artikeln

Header/Name/First row	Example value	Note
Employee ID	E123456	Column & value mandatory, must be in column 1
First Name	Testman	Column & value mandatory, must be in column 2
Last Name	Foobar	Column & value mandatory, must be in column 3
Email	Testman.Foobar@com.co	Value optional (If there is a value for PhoneNumber) , Column mandatory (must be on column 4)
PhoneNumber(Optional)	+00 1234 567	Value optional (if there is a value for Email). Need to have the country code in the beginning and the correct number format for that country(+46 XXX XXXXXX)
IsManager	1	Optional. Provides role manager to this user.
Group memberships	DEP_001	Optional. Can be repeated if users should be member in more then one group. This is OrgUnitID on group.
Group Name	Sales team	Optional. It can be repeated if users should be members in more than one group. This is externalid on group. It will not be used if "Group memberships" is set.
Employee ManagerID	E654321	Optional. The Employee ID on the manager.This will add this user as manager on groups that this person is member of.
Active	0	Optional. If empty it will leave user at is current state
Language	sv	Optional (BCP47)

Csv Group file

Krav och begränsningar:

Rubrikrad (första raden) måste finnas för alla 5 kolumner
Om ett fält är tomt kommer uppladdnings-API:et att hoppa över det värdet.
Format som stöds är: csv-filer separerade med ; (semikolon) eller | (rör).
Kodningen måste vara UTF-8

Du hittar en exempelfil här längst ner i artikeln

Header/Name/First row (all mandatory)	Example value	Note
OrgUnitID	DEP_001	Column & value mandatory, must be in column 1
Name	HR	Column & value mandatory, must be in column 2
Description	HR Department	Column mandatory, value optional, must be in column 3
ResponsibleManager	E654321	Column mandatory, value optional, must be in column 4. The externalid on manager. This will add this user as manager on this group
ParentOrgUnit	DEP_002	Column mandatory, value optional, must be in column 5. The OrgUnitID of the parent group (if not set will then be top/root group).

Bilagor (3)

xlsx

example_user....xlsx
18 KB

csv

example_groups.csv
140 Bytes

csv

example_users.csv
152 Bytes