Préférences

Configurations des services

Préferences du blog GET

`/api/v1/prefs/blog.json`

Retourne les préferences du blog : commentaires blog ouverts, commentaires blog anonymes, captcha commentaire blog

Format de sortie :

Schéma JSON
Modèle

data:{
    "has_comments_open": "boolean",
    "has_comments_anonymous": "boolean",
    "has_captcha": "boolean",
    "is_active": "boolean"
}

Nom	Type	Description
`has_comments_open`	boolean	Autorisation des nouveaux commentaires
`has_comments_anonymous`	boolean	Autorisation des commentaires anonymes
`has_captcha`	boolean	Protection des commentaires par captcha
`is_active`	boolean	Activation du blog

Préferences du catalogue GET

`/api/v1/prefs/catalog.json`

Retourne les préferences du catalogue : devise, la configuration du prix (HT ou TTC), exoneration TVA, commentaires catalogue ouverts, commentaires catalogue anonymes, captcha commentaire catalogue, vente en ligne activée

Format de sortie :

Schéma JSON
Modèle

data:{
    "currency": "string",
    "base_price": "string",
    "default_vat_rate": "float",
    "has_duty_free": "boolean",
    "has_comments_open": "boolean",
    "has_comments_anonymous": "boolean",
    "has_captcha": "boolean",
    "has_ecommerce": "boolean",
    "is_active": "boolean"
}

Nom	Type	Description
`currency`	string	devise du catalogue
`base_price`	string	Base d'affichage des prix. Les valeurs possibles sont : HT, TTC
`default_vat_rate`	float	Taux de tva par défaut
`has_duty_free`	boolean	Exoneration de TVA
`has_comments_open`	boolean	Autorisation des nouveaux commentaires
`has_comments_anonymous`	boolean	Autorisation des commentaires anonymes
`has_captcha`	boolean	Protection des commentaires par captcha
`has_ecommerce`	boolean	Activation de la vente en ligne
`is_active`	boolean	Activation du catalogue

Préferences de la médiatheque GET

`/api/v1/prefs/medias.json`

Retourne les tailles d'image de la médiatheque

Format de sortie :

Schéma JSON
Modèle

data:{
    "g_vignette_width": "integer",
    "g_vignette_height": "integer",
    "vignette_width": "integer",
    "vignette_height": "integer",
    "g_miniature_width": "integer",
    "g_miniature_height": "integer",
    "miniature_width": "integer",
    "miniature_height": "integer"
}

Nom	Type	Description
`g_vignette_width`	integer	Largeur des grandes vignettes en pixel
`g_vignette_height`	integer	Hauteur des grandes vignettes en pixel
`vignette_width`	integer	Largeur des vignettes en pixel
`vignette_height`	integer	Hauteur des vignettes en pixel
`g_miniature_width`	integer	Largeur des grandes miniatures en pixel
`g_miniature_height`	integer	Hauteur des grandes miniatures en pixel
`miniature_width`	integer	Largeur des miniatures en pixel
`miniature_height`	integer	Hauteur des miniatures en pixel

Préferences du site GET

`/api/v1/prefs/site.json`

Retourne les préferences du site

Format de sortie :

Schéma JSON
Modèle

data:{
    "site_name": "string",
    "site_excerpt": "string",
    "site_description": "string",
    "site_logo_url": "string",
    "is_contact_page_active": "boolean",
    "company_name": "string",
    "company_address": "string",
    "company_zipcode": "string",
    "company_city": "string",
    "company_country": "string",
    "company_phone": "string",
    "company_mobile": "string",
    "company_fax": "string",
    "theme": "string"
}

Nom	Type	Description
`site_name`	string	Nom du site
`site_excerpt`	string	Accroche
`site_description`	string	Description
`site_logo_url`Facultatif	string	Logo
`is_contact_page_active`	boolean	Activation de la page de contact
`company_name`	string	Nom de la société du propriétaire du site
`company_address`	string	Adresse du propriétaire du site
`company_zipcode`	string	Code postal du propriétaire du site
`company_city`	string	Ville du propriétaire du site
`company_country`	string	Pays du propriétaire du site
`company_phone`	string	Téléphone du propriétaire du site
`company_mobile`	string	Téléphone mobile du propriétaire du site
`company_fax`	string	Numéro de fax du propriétaire du site
`theme`	string	Code du theme utilisé par le site

Géographie

Liste les pays GET

`/api/v1/geo/countries.json`

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "integer",
        "name": "string",
        "code": "string",
        "group_id": "integer",
        "group_name": "string"
    }
]

Nom	Type	Description
`id`	integer	Identifiant du pays
`name`	string	Nom du pays
`code`	string	Code ISO du pays
`group_id`	integer	Identifiant du groupe
`group_name`	string	Nom du groupe

Détail d'un pays (code iso) GET

`/api/v1/geo/countries/{code}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code`	Obligatoire	string	Code du pays sur 2 caractères

Format de sortie :

Schéma JSON
Modèle

data:{
    "id": "integer",
    "name": "string",
    "code": "string",
    "group_id": "integer",
    "group_name": "string"
}

Nom	Type	Description
`id`	integer	Identifiant du pays
`name`	string	Nom du pays
`code`	string	Code ISO du pays
`group_id`	integer	Identifiant du groupe
`group_name`	string	Nom du groupe

Détail d'un pays GET

`/api/v1/geo/countries/{country_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`country_id`	Obligatoire	integer	Identifiant numérique du pays

Format de sortie :

Schéma JSON
Modèle

data:{
    "id": "integer",
    "name": "string",
    "code": "string",
    "group_id": "integer",
    "group_name": "string"
}

Nom	Type	Description
`id`	integer	Identifiant du pays
`name`	string	Nom du pays
`code`	string	Code ISO du pays
`group_id`	integer	Identifiant du groupe
`group_name`	string	Nom du groupe

Liste les départements d'un pays GET

`/api/v1/geo/countries/{country_id}/departements.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`country_id`	Obligatoire	integer	Identifiant numérique du pays

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "integer",
        "name": "string",
        "code": "string",
        "region_id": "integer"
    }
]

Nom	Type	Description
`id`	integer	Identifiant du département
`name`	string	Nom du département
`code`	string	Code du département
`region_id`	integer	Identifiant de la région

Liste les régions d'un pays GET

`/api/v1/geo/countries/{country_id}/regions.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`country_id`	Obligatoire	integer	Identifiant numérique du pays

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "integer",
        "name": "string"
    }
]

Nom	Type	Description
`id`	integer	Identifiant de la région
`name`	string	Nom de la région

Quota

Quota de requêtes disponibles GET

`/api/v1/rate.json`

Retourne le quota de requêtes disponibles pour l'IP du client. Ne consomme pas le quota.