API

We expose some parts of Approval Path functionality by API.

Authorization

You have to generate an API key in our app.

It is available in the Approval Path global view.

Click Apps in the top > Approval Path for Confluence > API Keys > Create a new API Key

Open

Setup your API key and copy or download it. The template has the following fields:

• Key name - provide your name for the API key, up to 40 characters long.

• Key value - non-modifiable field, shows the value of the key.

• Reveal - reveals the key. This is NOT one time operation - you can reveal the key at any time.

• Privileges (determines whether operation is allowed for the key)

  • Definition

    • Create - create a new approval definition,

    • Read/Get - retrive an approval definition by ID or a list of definitions,

    • Update - update a definition by its ID,

    • Delete - delete a definition.

  • Approval

    • Create - create an approval path,

    • Read/Get - retrive an approval path by ID or a list of approval paths,

    • Delete - delete an approval.

• Allow change performer origin - presents a valuable customization capability for users, empowering them to personalize change performer. Once checked, users are granted the flexibility to adjust performer origin according to their chosen parameters.

Open

Change Performer Origin select offers three distinct options:

1. User - to ensure smooth operations, it is essential to select a valid user as the new performer. This can be done by utilizing the option that allows the selection of a specific user.

2. Page creator - you to set user who created the page as the new change performer. In cases where the field does not have a valid user, you have the option to assign a default page creator to ensure continuity.

    

    

3. Page modifier - you can set user who last modified the page as the new change performer. In instances where the field lacks a valid user, you retain the option to select a default page modifier, ensuring a smooth transition in the performer's origin.

    

    

4. User from API call - API call body parameter allows for the passing of a user id. User ids can be limited to users from a designated group. In cases where the submitted user id is empty or does not contain a valid user, a default user can be selected. However, if the submitted user does not belong to the specified group, an error will be returned.

    

    

• Not valid before - set the start date for key validity.

• Not valid after - set the invalidation date for the key.

• Allowed IPs - set IPs or IP range that can use the key.

• Description - description of the key. Maximum 4000 characters.

• Creation time - non-modifiable field, the time when the key was created.

• Last modified - non-modifiable field, the time when the key was last modified.

• Last usage - non-modifiable field, the time when the key was last used.

• Usage Count - non-modifiable field, counter that shows how many times the key was used.

Using the Web API with API key

With key generated, you can now make a call to Web API. First of all, set Authorization and Content-Type headers in your REST client.

Endpoints

Base path: https://app.approval-path.com/webapi/v2