Register your integration
Get a client ID and a client secret before you start.
Every application that calls the Horus Software API is registered as an integration (an OAuth 2 client). Registration gives you the credentials your application needs to ask users for access to their data.
Request your credentials
Send an email to [email protected] with the subject New Api Integration Request, and include:
| Information | Example |
|---|---|
| Name of the integration | Acme Invoicing |
| Contact person and email address | Jane Smith, [email protected] |
| What the integration does with the API, and why | Pushes sales invoices and their PDF to the customer's accounting folder every night. |
| Redirect URL(s) | https://app.acme.example/horus/callback |
What you receive
| Credential | Description | Confidential? |
|---|---|---|
client_id | Public identifier of your integration. It is included in the authorization URL. | No |
client_secret | Secret key used by your server to exchange authorization codes and refresh tokens. | Yes |
Keep your client secret on your serverThe
client_secretmust never be shared, committed to a source repository, or embedded in code that runs on the user's device (browser, mobile or desktop applications). Store it like a password, for example in a secrets vault, and perform every token request from your server.
Redirect URLs
The redirect URL is the address of the page, in your application, where Horus sends the user back at the end of the authorization flow, together with the authorization code. It must be one of the URLs registered for your integration. Always send exactly the registered value: same scheme, host, port, path and trailing slash.
Use an HTTPS URL that belongs to your application.
You can register several URLs, for example one for production and one for your test environment. To add or change a URL later, write to [email protected].
Next step
Once you have your credentials, follow the Quickstart to connect a license and make your first API calls.
Updated about 1 hour ago