Add an app

  1. Click on the Apps tab.

    The list of your apps appears, you can consult, modify or add a new app.

    img

    Note

    If you have not yet created an application, the following screen appears:

    img

  2. Click on Add a new app

  3. The screen for defining a new application appears:

    • Identify your application, all this information can be used to publish the description of your application.

      • Name: User-friendly title of the application.
      • Description: Clear explanation for a customer describing the interest of your application.
      • Url: A link to one of your sites providing more detailed information about your application.
      • Contact email: An email address that your customers or Sage can use to contact you about your application.

    • Qualify the type of application desired:

      • Web Application: classic web application that can use a Client Secret.
      • Mobile Application: native application for mobile, for security the Client Secret is not used.
      • Single Page Application: a web application accessible via a single web page, for security the Client Secret is not used

    img

  4. You will now choose the Sage Active solution.

    Note

    This interface is designed to allow you to develop applications using several public APIs.

    Here, you will decide whether your application can function in different Sage Active markets, and consequently, on various Sage Active production solutions.
    For instance, if your application can be offered for both the French and Spanish markets, you will need to provide parameters for both the Sage Active Public API FR and the Sage Active Public API ES.

    For more information, refer to Key concepts / Environments.

    For example, choose Sage Active FR by clicking on the chevron to activate it.

    img

  5. The API information form appears.

    img

  6. Qualify the form information:

    Main information:

    • Callback URLs: List of authorized Callback URLs. You must fill at least one URL.

      If you are using Postman Web, then the callback URL is imposed by Postman.
      You will need to add this callback URL :

    • Logout URL: List of authorized Callback URLs.
    • Permissions: Permissions required by your application, by default Read and Write.

    You can also define several other URLs according to the needs of your application:

    • Allowed Origins: Authorized URL for call from Javascript to Auth0.
    • Web origins: Url authorized for request using Cross-Origin-authentication.

    Tip
    For each type of URL you can define several URLs to test your application in different environments.
    Click Add button to add a new field.

    img

  7. Once the information is filled in, click on the Save button.
    Your Client ID, Client Secret, Subscription keys are then generated.

    • Client ID, Client Secret will be needed to authenticate your application to Sage Active Public API V2.
    • Subscription keys are used to follow the consumption of Sage Active Public API V2.
    • Click on the eye icon to the right of the Client Secret to reveal it
    • You can renew the Client Secret at any time by clicking on the Renew icon, be careful in this case you will have to update it in your application.

    img

    • If your application type is not Web Application, the Client Secret will not be visible because it cannot be used in this context.
    • There is a primary key and a secondary key for the Subscription Key, for example this allows you to temporarily share a key, then revoke it later by generating a new key.

  8. Click on the Close button. The application you just created now appears in the list of applications.
    You can change its settings at any time.

    img

<  1. Register your company