Produits

L'API Produits vous permet de récupérer des informations sur les produits et les options disponibles.

Note

Seules les familles de produits pour lesquelles vous avez signé un contrat avec Covage sont disponibles en API, mais certains nouveaux produits et options peuvent ne pas avoir fait l'objet d'avenant contractuel et ne doivent pas être utilisés dans l'intervalle.

Famille de produits

Composition d'une famille de produits

Nom du champ	Type	Description
product_family_uuid	string	Identifiant de la famille de produits
code	string	Code de la famille de produits
name	string	Nom de la famille de produits
description	string	Description de la famille de produits
priority	string	Priorité de la famille de produits

Récupérer une famille de produits

Requête :

GET /api/product-families/o5kp26aa/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

{
    "product_family_uuid": "o5kp26aa",
    "code": "D",
    "name": "Degroupage KOSC",
    "description": "",
    "priority": "0007"
}

Lister les familles de produits

Requête :

GET /api/product-families/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "product_family_uuid": "o5kp26aa",
        "code": "D",
        "name": "Degroupage KOSC",
        "description": "",
        "priority": "0007"
    },
    {
        "product_family_uuid": "rsvjvpsy",
        "code": "A",
        "name": "ADSL",
        "description": "ADSL * technology : ADSL, VDSL, READSL",
        "priority": "0001"
    }
]

Lignes de produits

Composition d'une ligne de produits

Nom du champ	Type	Description
product_line_uuid	string	Identifiant de la ligne de produit
code	string	Code du produit
description	string	Description du produit
family	dictionnaire	Information sur la famille de produit
priority	string	Priorité du produit.
line_type	integer	Type of line

Dictionnaire family

Nom du champ	Type	Description
code	string	Code de la famille de produits
name	string	Nom de la famille de produits

Exemple :

{
    "product_line_uuid": "0atlcz9r",
    "code": "SL",
    "name": "SDSL-1M",
    "description": "SDSL-1M * Rate : 1 Mbits",
    "family": {
        "code": "S",
        "name": "SDSL"
    },
    "priority": "00020003",
    "line_type": 2
}

Récupérer une ligne de produits

Requête :

GET /api/product-lines/0atlcz9r/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

{
    "product_line_uuid": "0atlcz9r",
    "code": "SL",
    "name": "SDSL-1M",
    "description": "SDSL-1M * Rate : 1 Mbits",
    "family": {
        "code": "S",
        "name": "SDSL"
    },
    "priority": "00020003",
    "line_type": 2
}

Lister les lignes de produits

Requête :

GET /api/product-lines/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "product_line_uuid": "0atlcz9r",
        "code": "SL",
        "name": "SDSL-1M",
        "description": "SDSL-1M * Rate : 1 Mbits",
        "family": {
            "code": "S",
            "name": "SDSL"
        },
        "priority": "00020003",
        "line_type": 2
    },
    {
        "product_line_uuid": "8iiqme4o",
        "code": "SC",
        "name": "SDSL-3M",
        "description": "SDSL-3M * Rate : 3 Mbits",
        "family": {
            "code": "S",
            "name": "SDSL"
        },
        "priority": "00020005",
        "line_type": 2
    }
]

Produits

Composition d'un produit

Nom du champ	Type	Description
product_uuid	string	Identifiant unique du produit
code	string	Code du produit
name	string	Nom du produit
provider	string	Fournisseur réseau
description	string	Description du produit
priority	string	Priorité du produit
line	dictionnaire	Objet contenant les informations sur la ligne de produits
family	dictionnaire	Objet contenant les informations sur la famille de produits
options	dictionnaire	Objet contenant les options activables sur le produit
settings	dictionnaire	Objet contenant la configuration du produit

Dictionnaire line

Nom du champ	Type	Description
code	string	Code de la ligne de produits
name	string	Nom de la ligne de produits

Dictionnaire family

Nom du champ	Type	Description
code	string	Code de la famille de produits
name	string	Nom de la famille de produits

Dictionnaire options

L'objet options est un dictionnaire dont la clef est le code d'une option et la valeur un dictionnaire contenant la configuration de l'option pour ce produit.

Les codes d'options possibles sont les suivants:

Code	Description
grt	Garantie de temps de rétablissement
unlisted_number	Option de liste rouge
paid_desat	Option de désaturation
guaranteed_bandwidth	Option de débit garanti
portability	Option de portabilité
demarcation_device	Option modem
contract_term	Option durée de contrat

La configuration d'une option se compose des champs suivants:

Nom du champ	Type	Description
enabled	booléen	Indique si l'option est activée ou non
values	liste	Si le champ existe, il contient la liste des choix possibles pour cette option

Dictionnaire settings

Nom du champ	Type	Description
cos	string	Class of service, définie si le produit est garanti (G) ou non garanti (ng)
bit_rate	integer	Débit indicatif du produit
max_bitrate	integer	Débit maximum indicatif du produit
technology	string	Technologie du produit (SDSL ou ADSL)
unbundling	string	Type de dégroupage (FULL ou PARTIAL)
pairs_nb	integer	Nombre de paires du produit
mode	string	Mode du produit (EFM ou ATM)
sla	string	Service level agreement du produit (standard ou premium)

Récupérer un produit

Pour récupérer un produit, il faut faire un GET sur l'url /api/products/{product_uuid}/

Requête :

GET /api/products/0s7ci7c4/ HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

{
    "product_uuid": "0s7ci7c4",
    "code": "SA01",
    "name": "SDSL-0,5M-PREMIUM-G-1P-KOSC",
    "provider": "KOSC",
    "description": "SDSL 0,5Mbit/s  PREMIUM * Guaranteed * 1 pair * KOSC",
    "priority": "000200020001",
    "line": {
        "code": "SA",
        "name": "SDSL-0,5M"
    },
    "family": {
        "code": "S",
        "name": "SDSL"
    },
    "options": {
        "portability": {
            "enabled": true
        },
        "unlisted_number": {
            "enabled": true
        },
        "guaranteed_bandwidth": {
            "enabled": false
        },
        "paid_desat": {
            "enabled": true
        },
        "grt": {
            "enabled": true,
            "values": [
                "4h_24_7"
            ]
        },
        "demarcation_device": {
            "enabled": true
        },
        "contract_term": {
            "enabled": true,
            "values": [
                "36_months"
            ]
        }
    },
    "settings": {
        "cos": "G",
        "bit_rate": 500000,
        "technology": "SDSL",
        "unbundling": "FULL",
        "pairs_nb": 1,
        "mode": "EFM",
        "sla": "PREMIUM"
    }
}

Lister les produits

Pour lister les produits existants, il faut faire un GET sur l'url /api/products/

Il est possible de filtrer les résultats en ajoutant un des paramètres suivants à l'url

Nom du paramètre	Description
line	Code de la ligne de produits

Requête :

GET /api/products/?line=AM HTTP/1.1
Host: extranet.kosc-telecom.fr

Réponse :

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "product_uuid": "2nr0jwzs",
        "code": "AM08",
        "name": "ADSL-Max-partial-KOSC",
        "provider": "KOSC",
        "description": "ADSL * partial unbundling  * KOSC",
        "priority": "000100010008",
        "line": {
            "code": "AM",
            "name": "ADSL-Max"
        },
        "family": {
            "code": "A",
            "name": "ADSL"
        },
        "options": {
            "portability": {
                "enabled": false
            },
            "unlisted_number": {
                "enabled": true
            },
            "guaranteed_bandwidth": {
                "enabled": false
            },
            "paid_desat": {
                "enabled": false
            },
            "inner_wiring": {
                "enabled": true
            },
            "grt": {
                "enabled": true,
                "values": [
                    "4h_bhbd",
                    "4h_24_7"
                ]
            },
            "demarcation_device": {
                "enabled": false
            },
            "contract_term": {
                "enabled": true,
                "values": [
                    "36_months"
                ]
            }
        },
        "settings": {
            "cos": "ng",
            "max_bitrate": 24000000,
            "technology": "ADSL",
            "unbundling": "partial",
            "vlan": "MN",
            "pairs_nb": 1
        }
    },
    {
        "product_uuid": "i8k4fzfq",
        "code": "AM01",
        "name": "ADSL-Max-FULL-KOSC",
        "provider": "KOSC",
        "description": "ADSL * FULL unbundling  * KOSC",
        "priority": "000100010001",
        "line": {
            "code": "AM",
            "name": "ADSL-Max"
        },
        "family": {
            "code": "A",
            "name": "ADSL"
        },
        "options": {
            "portability": {
                "enabled": true
            },
            "unlisted_number": {
                "enabled": true
            },
            "guaranteed_bandwidth": {
                "enabled": false
            },
            "paid_desat": {
                "enabled": true
            },
            "inner_wiring": {
                "enabled": true
            },
            "grt": {
                "enabled": true,
                "values": [
                    "4h_bhbd",
                    "4h_24_7"
                ]
            },
            "demarcation_device": {
                "enabled": false
            },
            "contract_term": {
                "enabled": true,
                "values": [
                    "36_months"
                ]
            }
        },
        "settings": {
            "cos": "ng",
            "max_bitrate": 24000000,
            "technology": "ADSL",
            "unbundling": "FULL",
            "vlan": "MN",
            "pairs_nb": 1
        }
    }
]