Version imprimable multipages. Cliquer ici pour imprimer.

Retour à la version par défaut.

Legacy API

Documentation de l’ancienne API

Attention : cette API ne doit plus être utilisée pour de nouveaux projets, dorénavant il faut utiliser cette API

Les méthodes de l’API de l’ancien SI sont encore maintenues mais en utilisant l’architecture du nouveau SI.

Les concepts et l’approche de modélisation des données étant sensiblement différents, il peut y avoir quelques différences dans le comportement (voir encadré sur cette page).

Toutes les actions de la nouvelle API (v2) ne sont pas réalisables avec l’ancienne (v1). S’il vous manque une fonctionnalité il faut porter votre regard vers la nouvelle et le cas échéant nous faire remonter le besoin.

Nous insistons sur le fait que le portage de la v1 de l’API est une solution de dépannage pour vous permettre de continuer à utiliser nos services le temps que vous puissiez migrer vers la v2, et nous vous invitons à migrer au plus vite vers la v2 pour bénéficier du confort et de la meilleure expérience possible.

1 - Authentification

Obtenir un access token

Attention : cette API ne doit plus être utilisée pour de nouveaux projets, dorénavant il faut utiliser cette API

Le WebService Authentification est composé d’une méthode POST auth se situant à l’adresse suivante :

Cette méthode permet d’obtenir l’access token indispensable pour l’authentification et ainsi pourvoir consommer nos webservices.

La méthode auth prend deux paramètres :

  • email : il s’agit de l’email correspondant au login, il est rattaché aux droits d’utilisation des API dans notre SI.
  • mdp : le mot de passe correspondant.

Exemple d’appel :

curl -X POST "https://my.prizz-telecom.fr/sicom/auth" -H "accept: */*" -H "Content-Type: application/json" -d "{
\"email\": \"votrelogin\", \"mdp\": \"votremotdepasse\"}"

En retour vous obtiendrez l’acces token si votre compte est valide

2 - Commande

Actions concernant les commandes

Le WebService Commande est composé de plusieurs méthodes et elles se situent aux adresses suivantes :

Pour l’environnement de test opérateur :

Pour l’environnement de production :

2.1 - Création d'un contact

Création d’un nouveau contact

Cette méthode POST permet d’ajouter un nouveau contact à la liste.

Lors de la création d’une commande, un idContact pourra être indiqué dans le JSON aux endroits suivants pour y rattacher un contact :

  • contactsGTR / idContact : pour être informé des maintenances ou incidents en HO ou HNO
  • idContacts : pour être notifié des commentaires et avancées de la commande
  • idContactCommande : pour indiquer le créateur de la commande

La méthode est accessible : Sur l’environnement de test :

Le descriptif de la méthode est disponible ici :

2.2 - Liste des contacts

Obtenir la liste des contacts

Cette méthode GET permet l’obtention des identifiants de contacts opérateur. Ces identifiants seront utilisés lors de l’appel au WS de commande pour indiquer les contacts en suivi de la commande ou à avertir en cas d’incident.

Il est possible de créer de nouveaux contacts via https://my.prizz-telecom.fr/ dans la rubrique Administration/Utilisateurs.

La méthode est accessible : Sur l’environnement de test :

Sur l’environnement de production :

Le descriptif de la méthode est disponible ici :

2.3 - Liste des portes

Obtenir la liste des portes de livraison

Cette méthode GET permet l’obtention des codes des portes de livraison.

Sur l’environnement de test :

Sur l’environnement de production :

Il s’agit de la liste des portes de livraison possibles et dont vous devrez nous communiquer le code lors d’une commande de type L2.

Chaque porte est constituée des informations suivantes :

  • code : il s’agit du code de la porte à nous communiquer pour une commande de type L2
  • lib : description de la porte
  • site : localisation de la porte
  • bandwidth : débit de la porte en mb
  • is_default : si true, il s’agit de la porte par défaut sur laquelle nous effectuons la livraison.

Le descriptif de la méthode est disponible ici :

2.4 - Souscription FON

Passer une commande de type FON

Cette méthode permettait la prise de commande de type FON.

Elle a été discontinuée pour la V1 de l’API.

2.5 - Souscription L2

Passer une commande de type L2

Cette méthode POST permet d’effectuer une commande de type L2.

Sur l’environnement de test :

Sur l’environnement de production :

Détail des attributs du JSON :

  • idOffre : code Offre fourni par les WS éligibilité par la valeur idOffre.
  • idOptions : liste (pouvant être vide) de valeurs fournies par les WS éligibilité par idOption. L’option doit correspondre à l’offre à laquelle elle appartient.
  • contactsGTR : le type doit être soit HO pour Heures Ouvrées soit HNO pour Heures Non Ouvrées. Le contact doit être un contact de la liste des contacts Opérateurs fournie par le WS contacts. Il est possible de créer de nouveaux contacts via https://my.prizz-telecom.fr/ dans la rubrique Administration / Utilisateurs.
  • adresse : il s’agit des informations sur l’adresse à raccorder.
  • contactSite : il s’agit des informations pour contacter la personne nous permettant d’accéder au local du site à raccorder : nom / numéro de téléphone / mail / horaires auxquels nous pouvons joindre la personne.
  • idContactCommande : identifiant du contact correspondant à la personne effectuant la commande (paramètre facultatif).
  • idContacts : liste des contacts assurant le suivi de la commande. Ces contacts recevront les notifications par mail. La liste des contacts Opérateurs possibles est fournie par le WS contacts.
  • infosActivationService :
  • refPorte : valeur correspondant au code de la porte de Livraison fourni par le WS interfaceLivraison. Si vous n’avez pas encore de porte de livraison, merci de contacter l’ADV.
  • siteUtilisateurFinal : liste fermée devant correspondre à l’une des valeurs suivantes : « Transparence aux CVLAN (QinQ) », « Flux tagué C-VLAN », « Flux non tagué »
  • porteLivraison : liste fermée devant correspondre à l’une des valeurs suivantes : « Transparence aux CVLAN (QinQ) », « Flux tagué C-VLAN », « Flux non tagué »
  • interfaceLivraison : chaînes de caractères correspondant à « 10/100/1000 Base T », « 1000 Base SX », « 1000 Base LX » ou éventuellement une autre valeur à indiquer.
  • nvlanSite : Si vous avez choisi « Flux tagué C-VLAN » pour le siteUtilisateurFinal, vous pouvez spécifier un N° de Vlan pour le site.
  • nvlanPorte : Si vous avez choisi « Flux tagué C-VLAN » pour la porteLivraison, vous pouvez spécifier un N° de Vlan pour le site.

En cas de retour “succès”, l’information importante de la réponse est la valeur « ref ». Elle contient la référence commerciale de votre commande et vous permet de retrouver facilement votre commande sur le site https://my.prizztelecom.fr/ ou d’obtenir le suivi de la commande via l’API de suivi.

Le descriptif de la méthode est disponible ici :

2.6 - Suivi de commmande

Suivre l’état d’avancement d’une commande

Cette méthode GET permet de suivre l’état d’avancement d’une commande.

Sur l’environnement de test :

La méthode prend donc en paramètre la référence de la commande dont le suivi est souhaité.

Exemple d’appel :

curl -X 'GET' 'http://sandbox.prizz-telecom.fr/sicom/histoCommandes/suivi/XXXXXXXXX -H 'accept: */*' -H 'Authorization: Bearer votreToken

Le descriptif de la méthode est disponible ici :

3 - Catalogue

Récupération des offres catalogue

Attention : cette API ne doit plus être utilisée pour de nouveaux projets, dorénavant il faut utiliser cette API

Le WebService Catalogue est composé d’une méthode GET se situant à l’adresse suivante :

Cette méthode permet de lister les offres au catalogue. Il s’agit de l’ensemble des couples « offre – frais d’accès au service » éligibles et possédant un identifiant produit unique idProduit, que l’on peut retrouver dans l’api éligibilité avec l’attribut idOffreFas.

La méthode ne prend aucun paramètre, uniquement le token d’authentification.

Exemple d’appel :

curl -X GET "https://my.prizz-telecom.fr/sicom/catalogues" -H "accept: */*" -H "Authorization: Bearer votreToken"

Le retour est un JSON composé d’une liste de produits composés des attributs suivants :

  • famille : nom de la famille
  • idProduit : identifiant du produit et correspondant à idOffreFas de l’api éligibilité.
  • libelle : libellé du produit
  • engagement : engagement en mois.
  • debitDescendantMax : débit descendant maximal en Mb/s
  • debitDescendantGaranti : débit descendant garanti en Mb/s
  • debitMontantMax : débit montant maximal en Mb/s
  • debitMontantGaranti : débit montant garanti en Mb/s
  • prixHt : prix HT de l’offre
  • prixSurDevis : booléen indiquant si le prix de l’offre est « sur devis »
  • recurrent : booléen indiquant si le prix l’offre est récurrent
  • periodicite : périodicité de l’offre si celle-ci est récurrente
  • zone : zone commerciale
  • fasSurDevis : booléen indiquant si les FAS sont sur devis
  • fas : montant Ht des FAS

Le descriptif de la méthode est disponible ici :

4 - Éligibilité

Tests d’éligibilités

Attention : cette API ne doit plus être utilisée pour de nouveaux projets, dorénavant il faut utiliser cette API

Le WebService Eligibilité est composé de deux méthodes POST et elles se situent aux adresses suivantes :

Pour l’environnement de test opérateur :

Pour l’environnement de production :

Éligibilité via une adresse

La première méthode permet de savoir si une adresse donnée est éligible et de connaître les offres disponibles ainsi que le coût des frais d’accès au service.

La méthode eligibilites/operateur prend en paramètre un JSON composé de :

  • codePostal : code postal de l’adresse à tester
  • numero : numéro de la rue
  • rue : le nom de la rue sans le type de voie
  • typeVoie : le type de la voie de l’adresse à tester
  • ville : ville de l’adresse à tester
  • idOffres (facultatif) : liste des identifiants d’offre. L’API filtrera la recherche sur les offres demandées.
  • civilite (facultatif) : civilité de la personne demandant le test d’éligibilité. 1 pour Monsieur 2 pour Madame.
  • nom (facultatif) : nom de la personne demandant le test d’éligibilité.
  • prenom (facultatif) : prénom de la personne demandant le test d’éligibilité.

Exemple d’appel :

curl -X POST "https://my.prizz-telecom.fr/sicom/eligibilites/operateur" -H "accept: */*" -H "Authorization: Bearer
votreToken" -H "Content-Type: application/json" -d "{ \"codePostal\": \"75001\", \"numero\": 14, \"rue\": \"SaintRoch\", \"typeVoie\": \"rue\", \"ville\": \"Paris\"}"

Les descriptifs des méthodes sont disponibles ici :