Abraxio APIs - Management

Abraxio APIs - Management


The APIs offered on the platform are available free of charge until 10/31/2024 inclusive.
For any additional information, contact your Customer Success Manager or send an email directly to subscription@abraxio.com .

Preamble

The APIs allow you to interface your IS with Abraxio to automate processes, retrieve data from Abraxio or integrate data into Abraxio.
API calls are secured using the OAuth2 protocol.

Getting started

  1. Step 1 : Go to Admin > Integrations > API
      
  1. Before any call to the platform, it is necessary to obtain an access token by means of API access, consisting of the pair of parameters (clientId, clientSecret):
    1. The clientId (similar to a user account) is an identifier shared between the client and Abraxio.
    2. The clientSecret (similar to a password) is known only to the client.
  2. Step 2: click on “ + Add API access ” and modify the key wording if necessary.
  3. Step 3: copy the secret and keep it safe in a secure space. Once you leave the page, you will no longer be able to recover it.
  4. Step 4 : Test the API calls by clicking on “ Go to test interface ”. You will be redirected to a swagger space allowing you to test the connection chain, the available APIs, the associated documentation:
    1. Click on Authorize and copy the ClientID and Client Secret
    2. Click on the /v1/echo API to check authentication validation
    3. Click an API and fill in the input parameters to examine the exchanged JSON feeds
  5. Step 5 : implement API calls in your applications.

API key management

You can create several keys if your architectural and town planning rules require it.
Deactivation temporarily suspends the validity of access.
Deletion permanently suspends the validity of the access.
API access has a validity period limited to 12 months. Ultimately, you will need to generate a new access and use it in your API calls.

Management

Absences

List of planned absences

GET /v1/collaborators/absences/{year}/{month}
This API allows you to read forecast absences for a given month.
Settings :
  1. Year (required)
  2. Month (required)
  3. ref (optional): allows you to filter on a collaborator by their reference
  4. email (optional): allows you to filter on a collaborator by their email
If no filter on an employee is passed as a parameter, this method returns the list of employees present for the month with for each the list of forecast absences for the month.

Updating forecast absences

PUT /v1/collaborators/absences/{year}/{month}
This API allows you to update an employee's forecast absences for a month.
Settings :
  1. Year (required)
  2. Month (required)
The body of the request contains an employee identified by their reference or email and their planned absences for the month. The API expects an absence value (maximum 1 for an absence over the entire day) per day of the month.
Each day must be unique, if the request body contains the same day several times, the last value will be retained
This route works by "cancel and replace", that is to say it expects to receive the employee's complete forecast absence situation for the month in order to replace what is currently known in Abraxio.

Timesheets

List of timesheets

GET /v1/timesheets/{year}/{month}
This API allows you to retrieve details from Abraxio timesheets.
Input parameters:
  1. Year (required)
  2. Month (required)
  3. Status (optional): if not specified, returns all timesheets

Finance

Orders

Importing a batch of orders to integrate

POST /v1/orders/import
This API allows you to import a batch of commands to integrate.
Setting :
  1. allowDirectIntegration (boolean): if this parameter is true, orders for which all lines are recognized will be directly integrated into the budget
The request body contains a list of commands to import and returns an identifier of the import batch.
Limitations: A query can contain a maximum of 100 orders and an order has a maximum of 10 lines

GET /v1/orders/import/{id}
This API allows you to obtain the progress status of the import of a batch. It takes as a parameter a batch identifier returned by the POST import request.
For each command in the batch, it returns:
  1. The content of the import request
  2. The import status of the order:
    1. Rejected
    2. To integrate
    3. Integrated
  3. A list of error messages and warnings from the import

    • Related Articles

    • Abraxio APIs - General

      The APIs offered on the platform are available free of charge until 10/31/2024 inclusive. For any additional information, contact your Customer Success Manager or send an email directly to subscription@abraxio.com . Two categories of APIs are made ...

    • Configuration of the Management module

      Timesheets Section Abraxio allows you to manage your teams' timesheets and allocate the times entered to the budget lines of your projects and activities. Enable time recording to make time management features visible in the Abraxio platform In the ...

    • Abraxio APIs - PowerBI Tutorial

      The APIs offered on the platform are available free of charge until 10/31/2024 inclusive. For any additional information, contact your Customer Success Manager or send an email directly to subscription@abraxio.com . Connect your data to the Abraxio ...

    • Collaborator management

      Introduction The purpose of the Management module is to manage teams and Collaborators. As a Team Manager, you can describe your organisation, your teams and your Collaborators. This article describes the various elements of describing and ...

    • Document management

      Introduction This article describes the main principles of Documents Module in Abraxio, in particular the associations and the rules of accessibility rules of these documents for each user. Overview of Abraxio DMS (Document Management System) Each ...