Generate an API key
Sign in to your Sympa HR organization, then open Settings and select API to manage
API interfaces.
- Format:
https://{your-company}.sympahr.net
Configure the API interface
Create or select an interface under API Settings. Give it an Interface name,
then enable the methods this connection needs under Interface type: Get,
Post and Patch.
- Each interface exposes only the fields your administrator adds to it, so make sure the fields you need are configured on this interface.
Choose the ApiKey authentication method
On the interface’s authentication settings, choose ApiKey as the authentication
method, then generate the key.
- The key is sent on every request as the
X-ApiKeyheader.
Copy the API key
Copy the API Key across.
Link the Account
Connect
- Click Connect.
- If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
- Once authorization is successful, you will see a confirmation popup.
Use Actions