Abraxio API - Mise en route

Abraxio API - Mise en route

Préambule

Les API permettent d'interfacer votre SI avec Abraxio pour automatiser des processus, récupérer des données d'Abraxio ou intégrer des données dans Abraxio.
Les appels API sont sécurisés selon le protocole OAuth2.

Présentation des scopes

Au moment de créer vos accès API, vous pouvez choisir d'inclure dans votre accès tout ou partie du périmètre auquel votre souscription vous donne droit. La création d'un nouvel accès passe donc nécessairement par le choix de scopes associés. 
Voici un récapitulatif des scopes disponibles par souscription.
NB : l'indication "/*" sur une route API désigne "toutes les routes qui commencent par"

Souscription
Scope
Routes API
Description
API reporting
dataset.finance.read
- datasets/budgets/*
- datasets/timesheets/dimensions
- datasets/decisions/dimensions
Liste des exercices budgétaires, lignes budgétaires, archives et arrêtés, commandes, factures
dataset.portfolios.read
- datasets/projects/*
- datasets/decisions/dimensions
Liste des projets, risques, jalons et rapports flashs
 dataset.management.read
 - datasets/collaborators/*
 - datasets/timesheets/{year}
 Liste des collaborateurs, de leurs situations et  leurs affectations et des feuilles de temps
 dataset.suppliers.read
 - datasets/suppliers/*
 - datasets/decisions/dimensions
 Liste des fournisseurs, des contrats et leurs échéances, et des évaluations
API transactionnelles
management.read
- collaborators/absences
- timesheets
Liste des absences prévisionnelles et détail des feuilles de temps saisies
management.write
- collaborators/absences
Import des absences prévisionnelles pour un mois donné
finance.read
- orders/import
- invoices/import
État d'avancement de l'import des commandes/factures
finance.write
- orders/import
- invoices/import

Import des commandes/factures

 suppliers.read
 - suppliers/*
 Lecture des fournisseurs
 suppliers.write
 - suppliers/*
 Création / Édition des fournisseurs
 portfolios.read
 - portfolios/*
 Lecture des portefeuilles, projets et activités
 portfolios.write
 - portfolios/*
 Création des projets et activités

Création d'un accès API

  1. Étape 1 : Accéder à Admin > Intégrations > API
  2. Étape 2 : cliquer sur "+ Ajouter un accès API" et renseigner le libellé de l'accès ainsi que le scope souhaité.

  1. Étape 3 : cliquer sur "Enregistrer". L'enregistrement génère automatiquement un jeton d'accès, constitué du couple de paramètres (clientId, clientSecret) :
    1. Le clientId (assimilable à un compte utilisateur) est un identifiant partagé entre le client et Abraxio.
    2. Le clientSecret (assimilable à un mot de passe) est connu uniquement du client.
  2. Étape 4 : copier le secret et garder le précieusement dans un espace sécurisé. Dès que vous aurez quitté la page, vous ne pourrez plus le récupérer.
  3. Étape 5 : tester les appels API en cliquant sur "Accéder à l'interface de test". Vous serez redirigé vers : api-docs.abraxio.com, vous permettant de tester la chaine de connexion, les API disponibles et la documentation associée :
    1. Cliquer sur Authorize, copier le ClientID et le Client Secret et cocher le(s) scope(s) souhaité(s)
    2. Cliquer sur l'API /v1/echo pour vérifier la validation de l'authentification
    3. Cliquer sur une API et renseigner les paramètres d'entrée pour examiner les flux JSON échangés
  4. Étape 6 : implémenter les appels API dans vos applicatifs.

Gestion des clés API

Vous pouvez créer plusieurs clés si besoin.
La désactivation suspend temporairement la validité de l'accès.
La suppression suspend définitivement la validité de l'accès.

Gestion des rappels



  1. Superviseur accès API : utilisateur Abraxio en charge de la supervision des accès API
  2. Autre destinataire : champ supplémentaire dans lequel vous pouvez renseigner une adresse email en complément du superviseur
  3. Délai de rappel des expirations : nombre de mois avant expiration à partir desquels Abraxio envoie un email par semaine au superviseur et à l'autre destinataire. Afin d'annuler le rappel, désactivez l'accès API concerné
Warning
Un accès API a une durée de validité limitée à 12 mois. Au terme, il faudra générer un nouvel accès et l'utiliser dans vos appels API.