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 :

data:{
    "account_number": "string",
    "account_type": "string",
    "account_level": "string",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "affiliation_code": "string",
    "affiliation_url": "string"
}
NomTypeDescription
account_numberstringNuméro du compte
account_typestringType de compte
account_levelstringNiveau du compte
creation_datestringDate de création du compte
creation_date_fstringDate de création du compte formatée
creation_date_timestampintegerDate de création du compte formatée en timestamp
affiliation_codestringCode d'affiliation
affiliation_urlstringUrl d'affiliation
Récupère les coordonnées du compte GET
/v1/account/contact.json

Format de sortie :

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"
}
NomTypeDescription
firstnamestringPrénom du propriétaire du compte
lastnamestringNom du propriétaire du compte
civilitystringCivilité du propriétaire du compte. Les valeurs possibles sont : Mr, Mrs, Miss
functionstringFonction du propriétaire du compte
phonestringTéléphone du propriétaire du compte
emailstringEmail du propriétaire du compte
company_namestringNom de la société
company_addressstringAdresse de la société
company_zipcodestringCode postal de la société
company_citystringVille de la société
company_country_idintegerIdentifiant du pays de la société
company_countryFacultatifstringNom du pays de la société
company_formestringForme juridique
company_siretstringNuméro Siret
company_capitalstringCapital
company_rcsstringNuméro RCS
company_nafstringNuméro NAF
company_tvastringNuméro TVA
Modifie les coordonnées du compte PUT
/v1/account/contact.json

Paramètres supportés par ce endpoint :

NomTypeDescription
firstnamestringPrénom du propriétaire du compte
lastnamestringNom du propriétaire du compte
civilitystringCivilité du propriétaire du compte
Les valeurs attendues sont : Mr, Mrs, Miss
functionstringFonction du propriétaire du compte
phonestringTéléphone du propriétaire du compte
emailstringEmail du propriétaire du compte
company_namestringNom de la société
company_addressstringAdresse de la société
company_zipcodestringCode postal de la société
company_citystringVille de la société
company_country_idintegerIdentifiant du pays de la société
company_formestringForme juridique
company_siretstringNuméro Siret
company_capitalstringCapital
company_rcsstringNuméro RCS
company_nafstringNuméro NAF
company_tvastringNuméro TVA

Points de sauvegarde

Liste les points de sauvegarde GET
/v1/sites/{code_site}/backups.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "id": "string",
        "creation_date": "string"
    }
]
NomTypeDescription
idstringIdentifiant
creation_datestringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "job_id": "integer"
}
NomTypeDescription
job_idintegerIdentifiant
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 :

NomTypeDescription
code_siteObligatoirestringCode site
dateObligatoirestringDate du point de sauvegarde

Format de sortie :

data:{
    "job_id": "integer"
}
NomTypeDescription
job_idintegerIdentifiant

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 :

NomTypeDescription
code_siteObligatoirestringCode site
typestringFiltre le type des actions :
loginConnexions
updateMises à jour
commentCommentaires
checkoutCommandes
formFormulaires

Les valeurs attendues sont : login, update, comment, checkout, form
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

data:[
    {
        "activity_id": "integer",
        "text": "string",
        "type": "string",
        "user_name": "string",
        "user_profil": "string",
        "avatar_url": "string",
        "avatar_thumb_url": "string",
        "customer_id": "integer",
        "creation_date": "string"
    }
]
NomTypeDescription
activity_idintegerIdentifiant de l'entrée de l'activité
textstringIntitulé de l'activité
typestringType d'activité. Les valeurs possibles sont : login, update, comment, checkout, form
user_namestringNom de l'utilisateur auyant généré cette activité
user_profilstringType de profil de l'utilisateur
avatar_urlstringUrl de l'avatar du client
avatar_thumb_urlstringUrl de la miniature de l'avatar du client
customer_idFacultatifintegerIdentifiant client
creation_datestringDate de création
Statistiques ecommerce 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 :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

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"
    }
}
NomTypeDescription
formsFacultatifobjectStatistiques de Dismoi
unread_responsesintegerNombre de réponses non lues
checkoutFacultatifobjectStatistiques des commandes
pending_ordersintegerNombre commandes à traiter
pending_orders_amountintegerMontant HT des commandes à traiter
pending_orders_amount_labelstringMontant HT des commandes à traiter avec devise
average_cartintegerPanier moyen
average_cart_labelstringPanier moyen avec devise
monthly_transformationintegerTaux de transformation des 30 derniers jours
monthly_transformation_labelstringTaux de transformation des 30 derniers jours en pourcentage
catalogFacultatifobjectStatistiques du catalogue
stock_shortage_countintegerNombre de produits affichés en rupture totale
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 :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "visitors": "integer"
}
NomTypeDescription
visitorsintegerNombre 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 :

NomTypeDescription
code_siteObligatoirestringCode site
start_dateDateDate de début
end_dateDateDate de fin

Format de sortie :

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"
        }
    ]
}
NomTypeDescription
start_datestringDate de début des statistiques
end_datestringDate de fin des statistiques
visitorsintegerNombre total de visites sur la période
pageviewsintegerNombre total de pages vues sur la période
api_hitsintegerNombre total de requêtes API Front-office sur la période
salesFacultatifintegerChiffre d'affaire total sur la période
sales_labelFacultatifstringChiffre d'affaire total sur la période avec devise
daysobjectDétail pour chaque jour
datestringJour des données statistiques
pageviewsintegerNombre de pages vues de ce jour
visitorsintegerNombre de visites de ce jour
api_hitsintegerNombre de requêtes API Front-office de ce jour
salesFacultatifintegerChiffre 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 :

NomTypeDescription
code_siteObligatoirestringCode site
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
bpQuota bande passante
api_pfoQuota api front
formsQuota formulaires
productsQuota produits
usersQuota utilisateurs

Format de sortie :

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"
    }
}
NomTypeDescription
spaceobjectEspace disponible
mediasintegerTaille des médias en octets
datasintegerTaille des des fichiers en octets
ftpintegerTaille de l'espace FTP en octets
usedintegerEspace utilisé en octets
freeintegerEspace disponible en octets
totalintegerEspace autorisé en octets
bandwidthFacultatifobjectBande passante
usedintegerBande passante utilisée en octet
freeintegerBande passante disponible en octet
totalintegerBande passante autorisé en octet
api_pfoFacultatifobjectRequêtes api
usedintegerQuantité utilisée
freeintegerQuantité disponible
totalintegerQuantité maxiamle autorisée
formsFacultatifobjectFormulaires
usedintegerQuantité utilisée
freeintegerQuantité disponible
totalintegerQuantité maxiamle autorisée
productsFacultatifobjectProduits
usedintegerQuantité utilisée
freeintegerQuantité disponible
totalintegerQuantité maxiamle autorisée
usersFacultatifobjectUtilisateurs
usedintegerQuantité utilisée
freeintegerQuantité disponible
totalintegerQuantité maxiamle autorisée

Abonnement

Liste des formules disponibles GET
/v1/plans.json

Format de sortie :

data:[
    {
        "plan_id": "integer",
        "name": "string",
        "description": "string",
        "monthly_cost": "float",
        "monthly_cost_label": "string"
    }
]
NomTypeDescription
plan_idintegerIdentifiant unique de la formule
namestringNom de la formule
descriptionstringDescription de la formule
monthly_costfloatCout mensuel de la formule
monthly_cost_labelstringCout 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 :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

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"
}
NomTypeDescription
plan_idintegerIdentifiant unique de la formule
plan_namestringNom de la formule
monthly_costfloatCout mensuel total
balanceintegerCrédits restants
is_trialbooleanSite en période d'essai
is_demobooleanSite de démonstration
is_freebooleanSite gratuit
has_optionsbooleanOptions souscrites
closing_datestringDate de fermeture
closing_date_fstringDate de fermeture formatée
endtrial_datestringDate de fin de période d'essai
endtrial_date_fstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "code": "string",
        "name": "string",
        "quantity": "integer",
        "quantity_max": "integer",
        "quantity_remaining": "integer",
        "monthly_cost": "float",
        "monthly_cost_label": "string"
    }
]
NomTypeDescription
codestringCode unique de l'option
namestringNom de l'option
quantityintegerNombre de fois que l'option est souscrite
quantity_maxintegerNombre de fois que l'option peut être souscrite
quantity_remainingintegerNombre de fois que l'option peut encore être souscrite
monthly_costfloatCout mensuel de l'option
monthly_cost_labelstringCout mensuel de l'option avec devise

Sites

Liste les sites GET
/v1/sites.json

Paramètres supportés par ce endpoint :

NomTypeDescription
termstringTerme recherché
typestringType de site parmis les valeurs suivantes :
openSites ouverts
trialSites en période d'essai
closedSites fermés
closing_soonSites fermés prochainement
demoSites de démonstration
freeSites offerts

Les valeurs attendues sont : open, trial, closed, closing_soon, demo, free
sortstringDétermine l'ordre de tri parmis les critères suivants :
code_site / -code_siteCode site (ordre par défaut)
creation_date / -creation_dateDate de création
closing_date / -closing_dateDate de fermeture
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

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"
    }
]
NomTypeDescription
code_sitestringCode site
namestringNom du site
planobjectAbonnement
plan_idintegerIdentifiant unique de la formule
plan_namestringNom de la formule
balanceFacultatifintegerCrédits restants
is_closedbooleanSite fermé
is_trialbooleanSite en période d'essai
is_demobooleanSite de démonstration
is_freebooleanSite gratuit
closing_dateFacultatifstringDate de fermeture du site
endtrial_dateFacultatifstringDate de fin de période d'essai du site
domainstringDomaine principal front office
backofficestringURL du backoffice
creation_datestringDate de création du site
scopesFacultatifListDroits d'accès de l'utilisateur courant
featuresFacultatifListFonctionnalités souscrites
Créé un site POST
/v1/sites.json

Paramètres supportés par ce endpoint :

NomTypeDescription
copy_sitestringCode site du site à copier
plan_idObligatoirestringFormule du site
code_siteObligatoirestringCode site
site_nameObligatoirestringNom du site
contact_firstnameObligatoirestringPrénom du propriétaire du site
contact_lastnameObligatoirestringNom du propriétaire du site
contact_civilityObligatoirestringCivilité du propriétaire du site
Les valeurs attendues sont : Mr, Mrs, Miss
contact_emailObligatoirestringEmail du propriétaire du site
contact_addressObligatoirestringAdresse du propriétaire du site
contact_zipcodeObligatoirestringCode postal du propriétaire du site
contact_cityObligatoirestringVille du propriétaire du site
contact_country_idObligatoirestringPays du propriétaire du site
contact_phoneObligatoirestringTéléphone du propriétaire du site
contact_faxstringNuméro de fax du propriétaire du site
company_namestringNom de la société
company_formestringForme juridique
company_cnilstringNuméro CNIL
company_capitalstringCapital
company_siretstringNuméro Siret
company_rcsstringNuméro RCS
company_tvastringNuméro TVA
Détail d'un site GET
/v1/sites/{code_site}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestring
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
scopesDroits d'accès du token courant à ce site
featuresFonctions du site

Format de sortie :

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"
}
NomTypeDescription
code_sitestringCode site
namestringNom du site
planobjectAbonnement
plan_idintegerIdentifiant unique de la formule
plan_namestringNom de la formule
balanceFacultatifintegerCrédits restants
is_closedbooleanSite fermé
is_trialbooleanSite en période d'essai
is_demobooleanSite de démonstration
is_freebooleanSite gratuit
closing_dateFacultatifstringDate de fermeture du site
endtrial_dateFacultatifstringDate de fin de période d'essai du site
domainstringDomaine principal front office
backofficestringURL du backoffice
creation_datestringDate de création du site
scopesFacultatifListDroits d'accès de l'utilisateur courant
featuresFacultatifListFonctionnalités souscrites
Supprime un site DELETE
/v1/sites/{code_site}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestring