API

Application Programming Interface

Nous mettons à votre disposition la même API que celle utilisée par l’Espace Client, vous pourrez donc réaliser toutes les actions de celui-ci et plus encore.

Nos interfaces sont documentées avec la spécification OpenAPI (anciennement Swagger), une documentation générée vous permet de découvrir toutes les méthodes mises à votre disposition.

La spécification/définition de l’API au format yaml est téléchargeable, à l’aide de OpenApi-Generator qui vous permettent de générer très rapidement un “client” dans le langage de votre choix à partir de cette spécification.

Nous publions un client en PHP sur GitHub. Si vous souhaitez ajoutez un language n’hésitez pas a nous solliciter.

Nouveautés

décembre 2024

  • Ajout de l’estimation de la distance à construire dans les réponses de tests d’éligibilités voir response[].distance

novembre 2024

octobre 2024

août 2024

  • Ajout des combinaisons d’offres dans les réponses d’éligibilités, l’attribut ‘combinationId’ est unique à chaque offre et prochainement il sera possible de passer commande avec : voir response[].combinations

juillet 2024

  • Ajout de la liste des rôles liés a une entité légale voir la clé roles
  • Ajout de la date de première activation d’un service_contract

mai 2024

avril 2024

  • Les contacts sont ajoutés dans les réponses des devis, contrat de services et clients sur la clé contacts une autre clé configuredContacts vous permet de les lister avec leur rôle
  • Nouvelle route pour ajouter des commentaire sur les contrat de services : /service_contracts/{id}/comments

mars 2024


Authentification

Obtenir un jeton d’accès

Tests d'éligibilité

Comment faire des tests d’éligibilités depuis l’API

Souscription de services

La souscription passe par la création d’un devis sur cette offre. Cette API vous permet de créer vos devis. L’API est à votre disposition est assez riche, aussi, il existe plusieurs méthodes pour souscrire à une offre en utilisant différents cheminements.

Obtenir les prix d'une offre sans passer par un devis

Sur vos contrats vous avez accès à des listes de prix, celles-ci ne permettent pas à elles seule de calculer une offre parce qu’il existe des règles (exceptions) qui peuvent faire varier le prix. Jusque là, il fallait passer par la création d’un devis pour connaître le prix définitif (hors FAS a estimer).

Subnet attribué à un L3

Déterminer l’IP attribuée à un service

Doc de référence

Consulter la documentation généré automatiquement à partir du code de l’API