Alle våre kunder har mulighet til å benytte vårt API uavhengig av hvilket abonnement man har kjøpt. Med vårt Organisasjon API kan man sikre at organisasjonsstrukturen alltid er oppdatert med de siste endringene fra deres eget HR system. Dette vil spare dere for mye tid, og sikre at dere er GDPR compliant når dere bruker &frankly.
Vårt Organisasjon API kan benyttes på tre måter:
1. Send en komplett liste med brukere, grupper og organisasjonstruktur som vil holde &frankly oppdatert
2. Send en liste med brukere og grupper, slik at administrator kan sette opp organisasjonsstrukturen manuelt i &frankly
3. Send kun brukere, slik at administrator kan sette opp både grupper og organisasjonsstruktur i &frankly
Hvordan setter jeg det opp?
Å sette opp vårt API er ganskel rett frem, om du er kjent med hvordan API'et fungerer. Om dette ikke er kjent for deg, anbefaler vi at du får hjelp fra din IT avdeling, som vil kunne lese og forstå vår dokumentasjon for APIet.
Først og fremst, må du generere et token for å kunne autentisere mot API'et. Dette finner du ved Konto > API Access. Om du ikke setter opp APIet selv, kan du dele dette tokenet med personen som hjelper deg. Det er kun brukere med rollen Administrator som har tilgang til å generere API token.
Når dette er gjort, kaller du API'et som beskrevet i dokumentasjonen.
- API Documentation
- API Endpoint: https://org.api.andfrankly.com/v1/organization
- OpenAPI/Swagger definition
Mer informasjon om dette er tilgjengelig på engelsk
Unique identifiers:
When you sync to &frankly, a Unique Identifier will be required to manage the records you send. The Unique Identifiers are IDs generated in your own system that are only associated with one record.
When using this API, we consider what you send to it as the "Master State" and so we will mirror every latest update you send. It is important to make sure that all users AND groups are sent with the correct Unique Identifiers, because it is what our system will use to track all changes. Every time you sync, our system will perform the following actions:
- For existing unique identifiers: Our system will simply update accordingly (names, status, email address, group membership, etc.)
- For new unique identifiers: Our system will create a new record and add the properties that associated to that identifiers. For the syncs after that, it will be considered an existing record, so it will simply update as explained above.
- For missing unique identifiers: Our system will interpret that these users or groups should not longer exist in our records either, therefore it would delete them if they are missing on the sync. This is why it is imperative to include ALL the records for groups and users even if no changes are made.
- For users, you can restore them by running the sync again and ensuring all of them are included. After 30 days, the records of the user are deleted to comply with GDPR policies.
- For groups, they are simply archived in our records, which means you can restore them any time by adding them in the next sync.
Important information:
- Unique Identifiers cannot be updated via our API: since this is the property we use to base the rest of changes. For instance, if a group is deleted in your HRM system and created again, it is likely that your HRM system will assign a new identifier, same applies for users. This means that the old record (and its history) will be deleted from &frankly and a new record (often with the same name) will be created on &frankly but previous results will not be associated to it.
- If you do really need to sync old history to a new record, you need to contact our Support Team and provide them with the old identifier (that you removed from your system) and the new one so we update via backend in our records. Please note that we can assist on updating the identifier for any group, however, when it comes to users, we will only update the identifier if both email addresses match, to avoid thirds from accessing someone else's results.
- Users and Groups created manually outside of the API will not be touched in the syncs, this means they will not be updated or removed from &frankly unless they are manually changed through our interface too. You can lock your organizational tree to keep people from manually adding Users or Groups by going to Account -> User Management -> User Management and change the setting to "Locked for editing", please note that Administrator rights are needed to execute this change.