Pilotage des tickets

Spécifications techniques de l'outil de pilotage de tickets / API Eurafibre

v0.2 20200515

Présentation

Soucieux d’offrir à ses clients un service toujours plus performant, Eurafibre a développé et mis en place un système de pilotage de tickets sous forme d’API (Application Programmation Interface).

Cette interface, accessible uniquement dans le cadre d’un contrat de partenariat, permet aux clients d’Eurafibre d’intégrer la création et le suivi de leurs tickets envoyés au support Eurafibre sans devoir obligatoirement se connecter au Portail Client Eurafibre.

Fonctionnement

Le client partenaire a la possibilité d’opérer le pilotage des tickets au sein de son propre système informatique, ce qui lui permet, de manière autonome, de :

    •   Afficher la liste des tickets en cours
    •   Consulter un ticket
    •   Clôturer un ticket
    •   Répondre à un ticket
    •   Créer un nouveau ticket

Accès

L’utilisation de l’API étant strictement réservée aux clients Eurafibre, il est nécessaire d’utiliser une clé unique et personnelle pour accéder au service. Les clients qui souhaitent utiliser l’outil de pilotage de tickets doivent simplement en faire la demande auprès de notre service commercial.

Documentation

PARAMÈTRES D'ENTRÉE :

ParamètreValeurDescription
api_keyclé APIclé API unique du partenaire
node_idnuméronuméro du nœud
titletexteintitulé du ticket
contenttextecontenu du ticket
status0 / 1 / 20 = en cours
1 = résolu
2 = fermé
priority0 / 10 = basse
1 = haute
impact0 / 1 / 20 = léger
1 = lourd
2 = critique
concern_type0 / 10 = technique
1 = administratif
post_urlurlurl appelée pour notifier un évènement
attachments_attributesfichierfichier encodé en base64

Les données doivent être envoyées en GET dans l’URL

EXEMPLES :

Affichage des tickets en cours

GET : curl "https://api.eurafibre.fr/tickets/?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json »

Consultation d’un ticket

GET : curl "https://api.eurafibre.fr/tickets/1?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json »

 

PARAMÈTRES DE SORTIE (sous forme de tableau JSON) :

ParamètreValeurDescription
api_keyclé APIclé API unique du partenaire
ticket_idnuméronuméro (ID) du ticket
titletexteintitulé du ticket
contenttextecontenu du ticket
status0 / 1 / 20 = en cours
1 = résolu
2 = fermé
priority0 / 10 = basse
1 = haute
impact0 / 1 / 20 = léger
1 = lourd
2 = critique
concern_type0 / 10 = technique
1 = administratif
created_at
file_urlurlurl du fichier attaché
attachments_attributesfichierfichier encodé en base64

Les données doivent être envoyées via un PUT ou un POST JSON

EXEMPLES :

Clôture d’un ticket

PUT : curl "https://api.eurafibre.fr/tickets/1/close?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json" -X PUT -d "

Réponse à un ticket

PUT : curl "https://api.eurafibre.fr/tickets/replies?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json" -X POST -d '{"ticket_reply":{"ticket_id":1, "content": "user input","attachments_attributes":[{"file_base64":"data:text/plain;base64,Lgo="}]}}'

Création d’un ticket

POST : curl "https://api.eurafibre.fr/tickets?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json" -X POST -d '{"ticket":{"node_id":"11111","title »: »titre du ticket","content": « contenu du ticket","status":0,"priority":1,"impact":2,"concern_type":0,"post_url »: » url appelée ","attachments_attributes":[{"file_base64":"data:text/plain;base64,Lgo="}]}}

 

Les équipes Eurafibre restent à votre disposition pour tout complément d’information.