Skip to content

Commit

Permalink
Add information on API key and integration setup (#3)
Browse files Browse the repository at this point in the history
* enhance docs

* remove link

* improvements
  • Loading branch information
alexregier authored Mar 2, 2023
1 parent 30f7a82 commit 5896e73
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,19 @@ A Home Assistant integration with the Personio API.
* Install "Personio" as an integration in your settings.


## Setup

To use the integration, you need to have API access enabled on your Personio account. You might need to reach out to your People/HR department to request that.

1. Access your settings panel and click on "Generate new credential"
2. Specify an application identifier. You'll need that later.
3. You need to enable Read and Write Access to the "Attendances" data. Also read access to employee data is required to allow figuring out the Personio User ID based on email.
4. "Readable employee attributes" should be email.
5. You're now good to go. Install the integration in Home Assistant.
- Enter the "Client ID" and "Client Secret" that were generated
- "Partner identifier" can be left empty in most cases. It's only required in case you are a "partner company" of Personio.
- "Application identifier" is the identifier you specified in step 2.

[commits-shield]: https://img.shields.io/github/commit-activity/y/Sese-Schneider/ha-personio.svg?style=for-the-badge
[commits]: https://github.com/Sese-Schneider/ha-personio/commits/master
[downloads-shield]: https://img.shields.io/github/downloads/Sese-Schneider/ha-personio/total.svg?style=for-the-badge
Expand Down

0 comments on commit 5896e73

Please sign in to comment.