Skip to main content

Generate credentials for the Candis API

You need to create your own API credentials before you can connect to the Candis API.

Written by Thomas Heudecker
Updated over 2 weeks ago

Step-by-step guide

  1. Open Settings in Candis.

  2. Click Candis API.

  3. Click Generate new credentials.

  4. Enter a name for the credentials.
    Tip: Use the name of the software you want to connect (e.g., “Microsoft Business Central”, “Oracle NetSuite”, “Sage100”).

  5. Enter the redirect URL(s).

    • You can store more than one redirect URL.

    • Note: Only add redirect URLs that your connected software actually uses.

  6. Confirm your entries so Candis creates ClientID and ClientSecret.

  7. Store the ClientSecret securely right away.
    Note: Candis shows the ClientSecret only once. For security reasons, you cannot display it again later.

  8. Tick I have securely stored the Client Secret.

  9. Click Done to close the modal.

Note: If you did not save the ClientSecret, you must generate new credentials.


Redirect URL explained in more detail

A redirect URL (also called a “callback URL”) is the address Candis sends the browser to after login and consent. You mainly need a redirect URL when a software connects to Candis via OAuth 2.0 (a browser-based login and authorization flow).

This is what typically happens:

  1. You start the connection to Candis in the external software.

  2. The software opens the Candis login and consent screen in the browser.

  3. After successful login and consent, Candis redirects the browser to the redirect URL.

  4. The external software receives the response at that redirect URL and completes the connection process.

Rule of thumb: The redirect URL is the “return path” from the Candis login back to the software you want to connect.

Why is the redirect URL important?

  • Security: Candis only redirects to URLs you have stored in the credentials. This prevents redirecting an OAuth code to an unintended or malicious address.

  • Technical requirement: Candis must know where to redirect after login so the external software can complete the OAuth process.

Why can I add multiple redirect URLs?
Multiple redirect URLs help if you use, for example, a staging and production environment, or multiple instances of the same software.

Note: The redirect URL must match exactly. Differences like http vs https, a trailing slash (/callback vs /callback/), or a different subdomain often cause the login to fail.

Examples (for orientation):

  • https://app.your-tool.com/oauth/candis/callback

  • https://staging.your-tool.com/oauth/callback

  • http://localhost:3000/callback (only for local development, if your software uses this)


View or delete credentials

  1. Open SettingsCandis API.

  2. Click your created credentials.

  3. Review ClientID and redirect URL(s), or delete the credentials.

Note: You cannot view the ClientSecret again after creation.


Using credentials across multiple organizations

If you manage multiple organizations in Candis, one ClientID and one ClientSecret are enough. You can use these credentials for all organizations and also for multiple connected software solutions.


Use cases

  • You connect an integration tool and name the credentials “Make – Production”. You add the redirect URL(s) the tool requires for OAuth.

  • You work with multiple organizations (e.g., “DE GmbH” and “AT GmbH”) and use the same credentials to connect both organizations through the same integration.

Did this answer your question?