Gestion des sites

Gestion de compte

Récupère les informations du compte GET

`/v1/account.json`

Récupère les informations du compte (lien d'affiliation, niveau compte, n° compte).

Format de sortie :

Schéma JSON
Modèle

data:{
    "account_number": "string",
    "account_type": "string",
    "account_level": "string",
    "creation_date": "string"
}

Nom	Type	Description
`account_number`	string	Numéro du compte
`account_type`	string	Type de compte
`account_level`	string	Niveau du compte
`creation_date`	string	Date de création du compte

Récupère les coordonnées du compte GET

`/v1/account/contact.json`

Format de sortie :

Schéma JSON
Modèle

data:{
    "firstname": "string",
    "lastname": "string",
    "civility": "string",
    "function": "string",
    "phone": "string",
    "email": "string",
    "company_name": "string",
    "company_address": "string",
    "company_zipcode": "string",
    "company_city": "string",
    "company_country_id": "integer",
    "company_country": "string",
    "company_forme": "string",
    "company_siret": "string",
    "company_capital": "string",
    "company_rcs": "string",
    "company_naf": "string",
    "company_tva": "string"
}

Nom	Type	Description
`firstname`	string	Prénom du propriétaire du compte
`lastname`	string	Nom du propriétaire du compte
`civility`	string	Genre. Les valeurs possibles sont : Mr, Mrs, Miss
`function`	string	Fonction du propriétaire du compte
`phone`	string	Téléphone du propriétaire du compte
`email`	string	Email du propriétaire du compte
`company_name`	string	Nom de la société
`company_address`	string	Adresse de la société
`company_zipcode`	string	Code postal de la société
`company_city`	string	Ville de la société
`company_country_id`	integer	Identifiant du pays de la société
`company_country`Facultatif	string	Nom du pays de la société
`company_forme`	string	Forme juridique
`company_siret`	string	Numéro Siret
`company_capital`	string	Capital
`company_rcs`	string	Numéro RCS
`company_naf`	string	Numéro NAF
`company_tva`	string	Numéro TVA

Modifie les coordonnées du compte PUT

`/v1/account/contact.json`

Paramètres supportés par ce endpoint :

Nom	Type	Description
`firstname`	string	Prénom du propriétaire du compte
`lastname`	string	Nom du propriétaire du compte
`civility`	string	Civilité du propriétaire du compte Les valeurs attendues sont : Mr, Mrs, Miss
`function`	string	Fonction du propriétaire du compte
`phone`	string	Téléphone du propriétaire du compte
`email`	string	Email du propriétaire du compte
`company_name`	string	Nom de la société
`company_address`	string	Adresse de la société
`company_zipcode`	string	Code postal de la société
`company_city`	string	Ville de la société
`company_country_id`	integer	Identifiant du pays de la société
`company_forme`	string	Forme juridique
`company_siret`	string	Numéro Siret
`company_capital`	string	Capital
`company_rcs`	string	Numéro RCS
`company_naf`	string	Numéro NAF
`company_tva`	string	Numéro TVA

Points de sauvegarde

Liste les points de sauvegarde GET

`/v1/sites/{code_site}/backups.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "id": "string",
        "creation_date": "string"
    }
]

Nom	Type	Description
`id`	string	Identifiant
`creation_date`	string	Date de création

Crée un point de sauvegarde POST

`/v1/sites/{code_site}/backups.json`

La création d'un point de sauvegarde est asynchrone. Ce endpoint retourne une identifiant de job permettant de suivre l'état d'avancement de la création.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:{
    "job_id": "integer"
}

Nom	Type	Description
`job_id`	integer	Identifiant

Restaure un point de sauvegarde PUT

`/v1/sites/{code_site}/backups/{date}.json`

La restauration d'un point de sauvegarde est asynchrone. Ce endpoint retourne une identifiant de job permettant de suivre l'état d'avancement de la restauration.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`date`	Obligatoire	string	Date du point de sauvegarde

Format de sortie :

Schéma JSON
Modèle

data:{
    "job_id": "integer"
}

Nom	Type	Description
`job_id`	integer	Identifiant

Statistiques

Liste l'activité récente GET

`/v1/sites/{code_site}/logs.json`

Liste les actions faites sur le site.

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

type

array

Filtre les types des actions :

login	Connexions
update	Mises à jour
comment	Commentaires
checkout	Commandes
form	Formulaires

Les valeurs attendues sont : login, update, comment, checkout, form

since string Depuis une date

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 20)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "activity_id": "integer",
        "text": "string",
        "urn": "string",
        "type": "string",
        "user_name": "string",
        "user_profil": "string",
        "avatar_url": "string",
        "avatar_thumb_url": "string",
        "customer_id": "integer",
        "creation_date": "string"
    }
]

Nom	Type	Description
`activity_id`	integer	Identifiant de l'entrée de l'activité
`text`	string	Intitulé de l'activité
`urn`Facultatif	string	Identifiant de ressource
`type`	string	Type d'activité. Les valeurs possibles sont : login, update, comment, checkout, form
`user_name`	string	Nom de l'utilisateur auyant généré cette activité
`user_profil`	string	Type de profil de l'utilisateur
`avatar_url`	string	Url de l'avatar du client
`avatar_thumb_url`	string	Url de la miniature de l'avatar du client
`customer_id`Facultatif	integer	Identifiant client
`creation_date`	string	Date de création

Statistiques globales GET

`/v1/sites/{code_site}/stats.json`

Retourne les statistiques du sites : commandes, chiffre d'affaire, taux de transformation, produits en rupture de stock...

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:{
    "forms": {
        "unread_responses": "integer"
    },
    "checkout": {
        "pending_orders": "integer",
        "pending_orders_amount": "integer",
        "pending_orders_amount_label": "string",
        "average_cart": "integer",
        "average_cart_label": "string",
        "monthly_transformation": "integer",
        "monthly_transformation_label": "string"
    },
    "catalog": {
        "stock_shortage_count": "integer",
        "refillable_count": "integer"
    }
}

Nom	Type	Description
`forms`Facultatif	object	Statistiques de Dismoi
`unread_responses`	integer	Nombre de réponses non lues
`checkout`Facultatif	object	Statistiques des commandes
`pending_orders`	integer	Nombre commandes à traiter
`pending_orders_amount`	integer	Montant HT des commandes à traiter
`pending_orders_amount_label`	string	Montant HT des commandes à traiter avec devise
`average_cart`	integer	Panier moyen
`average_cart_label`	string	Panier moyen avec devise
`monthly_transformation`	integer	Taux de transformation des 30 derniers jours
`monthly_transformation_label`	string	Taux de transformation des 30 derniers jours en pourcentage
`catalog`Facultatif	object	Statistiques du catalogue
`stock_shortage_count`	integer	Nombre de produits affichés en rupture totale
`refillable_count`	integer	Nombre de produits à réapprovisionner

Statistiques temps réel GET

`/v1/sites/{code_site}/stats/live.json`

Fréquentation en temps réel du site.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:{
    "visitors": "integer"
}

Nom	Type	Description
`visitors`	integer	Nombre de visiteurs

Rapport de fréquentation GET

`/v1/sites/{code_site}/stats/report.json`

Retourne le nombre de visite journalier, de pages vues, de hits api et de CA sur une période donnée.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`start_date`		Date	Date de début
`end_date`		Date	Date de fin

Format de sortie :

Schéma JSON
Modèle

data:{
    "start_date": "string",
    "end_date": "string",
    "visitors": "integer",
    "pageviews": "integer",
    "api_hits": "integer",
    "sales": "integer",
    "sales_label": "string",
    "days": [
        {
            "date": "string",
            "pageviews": "integer",
            "visitors": "integer",
            "api_hits": "integer",
            "sales": "integer"
        }
    ]
}

Nom	Type	Description
`start_date`	string	Date de début des statistiques
`end_date`	string	Date de fin des statistiques
`visitors`	integer	Nombre total de visites sur la période
`pageviews`	integer	Nombre total de pages vues sur la période
`api_hits`	integer	Nombre total de requêtes API Front-office sur la période
`sales`Facultatif	integer	Chiffre d'affaire total sur la période
`sales_label`Facultatif	string	Chiffre d'affaire total sur la période avec devise
`days`	object	Détail pour chaque jour
`date`	string	Jour des données statistiques
`pageviews`	integer	Nombre de pages vues de ce jour
`visitors`	integer	Nombre de visites de ce jour
`api_hits`	integer	Nombre de requêtes API Front-office de ce jour
`sales`Facultatif	integer	Chiffre d'affaire de ce jour

Utilisation de ressources GET

`/v1/sites/{code_site}/stats/usage.json`

Retourne l'espace disque utilisé par les données et les fichiers du site, les données sur l'utilisation de la bande passante et l'api front-office.

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

bp	Quota bande passante
api_pfo	Quota api front
forms	Quota formulaires
products	Quota produits
users	Quota utilisateurs

Format de sortie :

Schéma JSON
Modèle

data:{
    "space": {
        "medias": "integer",
        "datas": "integer",
        "ftp": "integer",
        "used": "integer",
        "free": "integer",
        "total": "integer"
    },
    "bandwidth": {
        "used": "integer",
        "free": "integer",
        "total": "integer"
    },
    "api_pfo": {
        "used": "integer",
        "free": "integer",
        "total": "integer"
    },
    "forms": {
        "used": "integer",
        "free": "integer",
        "total": "integer"
    },
    "products": {
        "used": "integer",
        "free": "integer",
        "total": "integer"
    },
    "users": {
        "used": "integer",
        "free": "integer",
        "total": "integer"
    }
}

Nom	Type	Description
`space`	object	Espace disponible
`medias`	integer	Taille des médias en octets
`datas`	integer	Taille des des fichiers en octets
`ftp`	integer	Taille de l'espace FTP en octets
`used`	integer	Espace utilisé en octets
`free`	integer	Espace disponible en octets
`total`	integer	Espace autorisé en octets
`bandwidth`Facultatif	object	Bande passante
`used`	integer	Bande passante utilisée en octet
`free`	integer	Bande passante disponible en octet
`total`	integer	Bande passante autorisé en octet
`api_pfo`Facultatif	object	Requêtes api
`used`	integer	Quantité utilisée
`free`	integer	Quantité disponible
`total`	integer	Quantité maxiamle autorisée
`forms`Facultatif	object	Formulaires
`used`	integer	Quantité utilisée
`free`	integer	Quantité disponible
`total`	integer	Quantité maxiamle autorisée
`products`Facultatif	object	Produits
`used`	integer	Quantité utilisée
`free`	integer	Quantité disponible
`total`	integer	Quantité maxiamle autorisée
`users`Facultatif	object	Utilisateurs
`used`	integer	Quantité utilisée
`free`	integer	Quantité disponible
`total`	integer	Quantité maxiamle autorisée

Abonnement

Liste des formules disponibles GET

`/v1/plans.json`

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "plan_id": "integer",
        "name": "string",
        "description": "string",
        "monthly_cost": "float",
        "monthly_cost_label": "string"
    }
]

Nom	Type	Description
`plan_id`	integer	Identifiant unique de la formule
`name`	string	Nom de la formule
`description`	string	Description de la formule
`monthly_cost`	float	Cout mensuel de la formule
`monthly_cost_label`	string	Cout mensuel de la formule avec devise

Récupère la formule souscrite GET

`/v1/sites/{code_site}/subscriptions.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:{
    "plan_id": "integer",
    "plan_name": "string",
    "monthly_cost": "float",
    "balance": "integer",
    "is_trial": "boolean",
    "is_demo": "boolean",
    "is_free": "boolean",
    "has_options": "boolean",
    "closing_date": "string",
    "closing_date_f": "string",
    "endtrial_date": "string",
    "endtrial_date_f": "string"
}

Nom	Type	Description
`plan_id`	integer	Identifiant unique de la formule
`plan_name`	string	Nom de la formule
`monthly_cost`	float	Cout mensuel total
`balance`	integer	Crédits restants
`is_trial`	boolean	Site en période d'essai
`is_demo`	boolean	Site de démonstration
`is_free`	boolean	Site gratuit
`has_options`	boolean	Options souscrites
`closing_date`	string	Date de fermeture
`closing_date_f`	string	Date de fermeture formatée
`endtrial_date`	string	Date de fin de période d'essai
`endtrial_date_f`	string	Date de fin de période d'essai formatée

Récupère les options souscrites GET

`/v1/sites/{code_site}/subscriptions/options.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "code": "string",
        "name": "string",
        "quantity": "integer",
        "quantity_max": "integer",
        "quantity_remaining": "integer",
        "monthly_cost": "float",
        "monthly_cost_label": "string"
    }
]

Nom	Type	Description
`code`	string	Code unique de l'option
`name`	string	Nom de l'option
`quantity`	integer	Nombre de fois que l'option est souscrite
`quantity_max`	integer	Nombre de fois que l'option peut être souscrite
`quantity_remaining`	integer	Nombre de fois que l'option peut encore être souscrite
`monthly_cost`	float	Cout mensuel de l'option
`monthly_cost_label`	string	Cout mensuel de l'option avec devise

Sites

Liste les sites GET

`/v1/sites.json`

Paramètres supportés par ce endpoint :

Nom Type Description

term string Terme recherché

type

string

Type de site parmis les valeurs suivantes :

open	Sites ouverts
trial	Sites en période d'essai
closed	Sites fermés
closing_soon	Sites fermés prochainement
demo	Sites de démonstration
free	Sites offerts

Les valeurs attendues sont : open, trial, closed, closing_soon, demo, free

sort

string

Détermine l'ordre de tri parmis les critères suivants :

code_site / -code_site	Code site (ordre par défaut)
relevance	Pertinence
creation_date / -creation_date	Date de création
closing_date / -closing_date	Date de fermeture

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 20)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "code_site": "string",
        "name": "string",
        "plan": {
            "plan_id": "integer",
            "plan_name": "string",
            "balance": "integer",
            "is_closed": "boolean",
            "is_trial": "boolean",
            "is_demo": "boolean",
            "is_free": "boolean",
            "closing_date": "string",
            "endtrial_date": "string"
        },
        "domain": "string",
        "backoffice": "string",
        "creation_date": "string",
        "scopes": "List",
        "features": "List",
        "account": "List"
    }
]

Nom	Type	Description
`code_site`	string	Code site
`name`	string	Nom du site
`plan`	object	Abonnement
`plan_id`	integer	Identifiant unique de la formule
`plan_name`	string	Nom de la formule
`balance`Facultatif	integer	Crédits restants
`is_closed`	boolean	Site fermé
`is_trial`	boolean	Site en période d'essai
`is_demo`	boolean	Site de démonstration
`is_free`	boolean	Site gratuit
`closing_date`Facultatif	string	Date de fermeture du site
`endtrial_date`Facultatif	string	Date de fin de période d'essai du site
`domain`	string	Domaine principal front office
`backoffice`	string	URL du backoffice
`creation_date`	string	Date de création du site
`scopes`Facultatif	List	Droits d'accès de l'utilisateur courant
`features`Facultatif	List	Fonctionnalités souscrites
`account`Facultatif	List	Compte

Créé un site POST

`/v1/sites.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`copy_site`		string	Code site du site à copier
`plan_id`	Obligatoire	string	Formule du site
`code_site`	Obligatoire	string	Code site
`site_name`	Obligatoire	string	Nom du site
`contact_firstname`	Obligatoire	string	Prénom du propriétaire du site
`contact_lastname`	Obligatoire	string	Nom du propriétaire du site
`contact_civility`	Obligatoire	string	Civilité du propriétaire du site Les valeurs attendues sont : Mr, Mrs, Miss
`contact_email`	Obligatoire	string	Email du propriétaire du site
`contact_address`	Obligatoire	string	Adresse du propriétaire du site
`contact_zipcode`	Obligatoire	string	Code postal du propriétaire du site
`contact_city`	Obligatoire	string	Ville du propriétaire du site
`contact_country_id`	Obligatoire	string	Pays du propriétaire du site
`contact_phone`	Obligatoire	string	Téléphone du propriétaire du site
`contact_fax`		string	Numéro de fax du propriétaire du site
`company_name`		string	Nom de la société
`company_forme`		string	Forme juridique
`company_cnil`		string	Numéro CNIL
`company_capital`		string	Capital
`company_siret`		string	Numéro Siret
`company_rcs`		string	Numéro RCS
`company_tva`		string	Numéro TVA

Format de sortie :

Schéma JSON
Modèle

data:{
    "job_id": "integer"
}

Nom	Type	Description
`job_id`	integer	Identifiant

Détail d'un site GET

`/v1/sites/{code_site}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

scopes	Droits d'accès du token courant à ce site
features	Fonctions du site
account	Compte

Format de sortie :

Schéma JSON
Modèle

data:{
    "code_site": "string",
    "name": "string",
    "plan": {
        "plan_id": "integer",
        "plan_name": "string",
        "balance": "integer",
        "is_closed": "boolean",
        "is_trial": "boolean",
        "is_demo": "boolean",
        "is_free": "boolean",
        "closing_date": "string",
        "endtrial_date": "string"
    },
    "domain": "string",
    "backoffice": "string",
    "creation_date": "string",
    "scopes": "List",
    "features": "List",
    "account": "List"
}

Nom	Type	Description
`code_site`	string	Code site
`name`	string	Nom du site
`plan`	object	Abonnement
`plan_id`	integer	Identifiant unique de la formule
`plan_name`	string	Nom de la formule
`balance`Facultatif	integer	Crédits restants
`is_closed`	boolean	Site fermé
`is_trial`	boolean	Site en période d'essai
`is_demo`	boolean	Site de démonstration
`is_free`	boolean	Site gratuit
`closing_date`Facultatif	string	Date de fermeture du site
`endtrial_date`Facultatif	string	Date de fin de période d'essai du site
`domain`	string	Domaine principal front office
`backoffice`	string	URL du backoffice
`creation_date`	string	Date de création du site
`scopes`Facultatif	List	Droits d'accès de l'utilisateur courant
`features`Facultatif	List	Fonctionnalités souscrites
`account`Facultatif	List	Compte

Supprime un site DELETE

`/v1/sites/{code_site}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string