Vad menas med API och varför ska vi använda det?
Att koppla upp ett API mellan ert HR-system och &frankly innebär att ni automatiskt kan synkronisera medarbetarna och er organisatoriska struktur. Detta kallar vi för ett organisatoriskt API.
Det är också möjligt att hämta rådata från exempelvis KPI:er, svarsfrekvens, och resultat från frågor ställda i &frankly. Detta API kallar vi för ett “data-API”.
Hur fungerar det?
För att installera ett API i frankly behöver du vara administratör i verktyget. Om du inte satt upp ett API tidigare rekommenderar vi dig att fråga en tekniskt kunnig kollega om hjälp!
Logga in i &frankly och gå till Inställningar > API-access för att skapa en nyckel. Här kan du skapa accessnycklar som används för att programmatiskt få tillgång till &frankly's data, antingen för att sätta upp en integration för att automatiskt hantera anställda och grupper, eller för att komma åt resultatdata via vårt data-API.
För att skapa en nyckel, klicka på "Skapa en nyckel" och lägg till en beskrivning för att komma ihåg vad den används till.
Mer information om vårt API för att komma åt data i &frankly finns här (engelska): https://data.api.andfrankly.com Mer information om vårt API för att hantera användare och organisationsstruktr finns här (engelska): https://org.api.andfrankly.com För mer information om hur ni kan ladda upp filer som en del av en Managerad Integration (där vi tar emot filer från er för att läsa in i &frankly), se https://upload.api.andfrankly.com. För att använda detta gränssnitt via SFTP är ert användarnamn "andfrankly{{CompanyID}}" och lösenord en nyckel som skapas nedan.
Vilka fördelar finns det med att använda ett API?
Organisatoriskt API
Att automatiskt synkronisera användare och grupper i &frankly kommer underlätta er hantering av medarbetare i &frankly. Eftersom att synkroniseringen sker kontinuerligt kan ni se till att er gruppstruktur alltid är uppdaterad, att nya medarbetare läggs till samt att medarbetare som inte längre arbetar hos er finns kvar i systemet. Genom detta kommer ni kunna spara mycket tid och även säkerställa att ni följer GDPR-regler.
Data API
Att installera ett data API innebär att ni bland annat kan:
- Bygga era egna KPI summeringar
- Dela resultat, svarsfrekvens eller KPI:er i ert intranät
- Importera data till business intelligence-system där ni kan arbeta med och analysera datan
Nedan kan du läsa mer detaljerad information om API och hur det ska installeras, notera att det enbart finns tillgängligt på engelska.
About data API (advanced):
This API provides access to data points such as KPIs, Response rates and Result summaries for questions asked in &frankly, as well as supporting information that may be required (such as groups that exist, when questions have been scheduled, basic question information etc). Authentication to access this endpoint is handled by API tokens that can be generated from your &frankly account as an Administrator under Account and API tokens and should be passed as a header.
About organization API (advanced):
This API endpoint provides means to automatically update users and groups in &frankly, and can be used to e.g. set up an automated synchronization between your HR system and &frankly. When using this API, we consider what you send to it as "master" and i.e. will make sure that the current state in &frankly reflects the state that you send. This is done by considering users and groups that are provided through this API as managed. For managed users and groups, we can restrict manual changes in the application (if desired), and we will also perform corrections to all managed users and groups automatically via updates through this API. This means for example if you send a list of users A,B and C through this API, and in the next update you send users A,B and D, then user B will be renamed to b, C will be removed and user D will be added, and similarly for groups. User E that was created manually/outside of this API will be left alone, as will manually created groups.
The intended use of this API is to allow companies to send a set of users and groups that should always exist in &frankly (removing users that have left the company, and creating new users that have joined) and maintaining an up to date org-structure - but still allow users to create own groups outside of the structured outside of the org-structure.
It is possible to use this API in three manners:
- Send a full list of users and org structure that is kept up to date in &frankly,
- Send only a list of users and org units, allowing an administrator to build the tree based on these units, or
- Send only users, allowing an administrator to build & maintain their own org structure.
When using this API it is important to take care that any users AND org units that are sent are sent with correct unique identifiers, as it is what is used to base changes on. For example, if an org unit with identifier 0000A and name 'Sales Department' is sent to us and later it is removed because there is a new org unit with identifier 0000B that is named 'Sales Department', we will remove the old org unit in &frankly and create a new one (because it has a new unique identifier), which also means all historic results for the previous org unit will be removed/no longer possible to see.