# Sous-comptes

# Liste des sous-comptes

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/get

# Paramètres

Paramètre	Description
key	Votre clé API d'identification

# Résultats

 [ 
   {
     "id":"1","email":"[email protected]","civilite":"M","nom":"Nom 1","prenom":"Prenom 1","nom_entreprise":"Entreprise 1",
    "nom_commercial":"Nom commercial 1","adresse":"rue du test","ville":"Roanne","code_postal":"42300","pays":"France M\u00e9tropolitaine",
    "date_inscription":"1327843894","api_cle":"lacleapidusouscompte","solde_premium":"0","solde_email":"10","solde_fax":"10"
   ,"solde_fixe":"10","solde_mobile":"10","solde_direct_repondeur":"10","actif":1
   }
   ... 
]

# Ajouter un sous compte

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/add

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
civilite	(M, Mme)
nom
prenom
nom_entreprise
nom_commercial
raison	(entreprise, association, administration)
adresse
code_postal
ville
telephone_personnel
telephone_entreprise
email
motdepasse	Votre mot de passe
confirmation	Confirmation de votre mot de passe

# Résultats

Résultat	Description
`{resultat: 1, id: 400045, key: 3c6e0b8a9c15224a8228b9a98ca1531d}`	resultat = 1 = Elément ajouté avec succès id = identifiant unique du compte key = clé api du compte
`{resultat: 0, erreur: "Votre erreur"}`	resultat = 0 = Erreur lors de l'ajout erreur = Votre erreur

# Modifier un sous compte

# URL à appeler

https://www.spot-hit.fr/api/client/set

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
client	L'Identifiant unique du sous-compte
element	Elément que vous souhaitez modifier (nom, prenom, raison_sociale, nom_entreprise, nom_commercial, mot_de_passe, indicatif_defaut, email, identifiant_facture, code_comptable)
valeur	La nouvelle valeur que vous souhaitez lui attribuer

# Résultats

Résultat	Description
`{resultat: 1}`	resultat = 1 = Elément modifié avec succès
`{resultat: 0, erreur: [1,2]}`	resultat = 0 = Erreur lors de la modification erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

Numéro	Description
1	Elément non modifiable.
2	Valeur incorrecte/Email déjà utilisé
3	Veuillez ne pas utiliser d'adresse email jetable
4	Client introuvable/Pas la permission de modifier le client
5	Le mot de passe doit contenir entre 8 et 50 caractères, au moins une majuscule, une minuscule, un chiffre et un caractère spécial
6	Le mot de passe correspond à un ancien
7	Une erreur est survenue
8	Erreur SQL

# Récupérer la liste des éléments du sous-compte

# URL à appeler

https://www.spot-hit.fr/api/client/get

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
id	L'Identifiant unique du compte

# Résultats

Résultat	Description
`{resultat: true, data: {"first_name": "John", "last_name": "Doe", ...}}`	Tableau des données
`{resultat: false, erreurs: [1, 2, 3]}`	resultat = false = Erreur lors de la récupération des données erreurs = Tableau des erreurs rencontrées

# Correspondance

Eléments	Description
first_name	Prénom
last_name	Nom
civility	civilité
company_name	Nom entreprise
commercial_name	Nom commercial
address	Adresse
zip_code	Code postal
city	Ville
country	Pays
email	Email
business_phone	Téléphone entreprise
language	Langue
api_key	Clé API

# Tableau des erreurs

Numéro	Description
1	Valeur d'identifiant incorrecte
2	Valeur elément (elements) incorrecte
3	Compte introuvable

# Désactiver un sous compte

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/desactiver

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
id	Identifiant unique du sous-compte

# Résultats

Résultat	Description
`{resultat: 1}`	resultat = 1 = Elément désactivé avec succès
`{resultat: 0, erreur: [1,2]}`	resultat = 0 = Erreur lors de la désactivation erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

Numéro	Description
1	Id manquant
2	Client introuvable/Pas la permission de modifier le client

# Suspendre un sous compte

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/suspendu

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
id	Identifiant unique du sous-compte
etat	0 : Lever la suspension 1 : Suspendre

# Résultats

Résultat	Description
`{resultat: 1}`	resultat = 1 = Elément suspendu avec succès
`{resultat: 0, erreur: [1,2]}`	resultat = 0 = Erreur lors de la suspension erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

Numéro	Description
1	Id manquant
2	Client introuvable/Pas la permission de suspendre le client

# Transférer des crédits

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/transferer-credits

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
id_sous_compte	Identifiant du sous-compte
act	Type d'action : "credit" ou "debit"
type	Type de crédit : "premium", "direct_repondeur", "email", "mms", "fax"
credits	Nombre de crédits à transférer

# Résultats

Résultat	Description
`{resultat: 1}`	resultat = 1 = Opération effectué avec succès
`{resultat: 0, message: "message d'erreur"}`	message = Message de l'erreur rencontrée

# Paramétrer URL Push

# URL à appeler

https://www.spot-hit.fr/api/urls/edit

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
accuses	URL de réception des accusés de réception
stops	URL de réception des stops
reponses	URL de réception des réponses

# Résultats

Résultat	Description
`{resultat: 1}`	resultat = 1 = Opération effectué avec succès
`{resultat: 0, erreurs: "1,2"}`	resultat = 0 = Erreur lors de la modification erreurs = Liste des erreurs rencontrées

# Tableau des erreurs

Numéro	Description
1	Erreur interne

# Détail des campagnes

# URL à appeler

https://www.spot-hit.fr/api/client/details_campagnes

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
format	json ou csv (par défaut json)
debut	Timestamp unix début sélection (par défaut le 1er du mois dernier)
fin	Timestamp unix fin sélection (par défaut le 31 du mois dernier)

# Modifier la facturation

# URL à appeler

https://www.spot-hit.fr/api/billing/edit

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
id	ID du compte client
facturation	(0 = Pre-payé, 1 = Post-payé)

# Résultats

Résultat	Description
`{resultat: 1}`	resultat = 1 = Elément ajouté avec succès
`{resultat: 0, erreurs: "1,2"}`	resultat = 0 = Erreur lors de la modification erreurs = Liste des erreurs rencontrées

# Ajouter un client (Marque-blanche)

# URL à appeler

https://www.spot-hit.fr/api/client/creer

Attention

Vous devez remplacer https://www.spot-hit.fr par le domaine de votre marque blanche.

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
raison	Raison sociale du compte : "entreprise", "association" ou "administration"
nom_entreprise	Nom de l'entreprise du compte
adresse	Adresse du compte
code_postal	Code postal du compte
ville	Ville du compte
pays	Pays du compte
civilite	Civilité du compte : "M" ou "Mme"
nom	Nom du compte
prenom	Prénom du compte
email	Email du compte
telephone_entreprise	Téléphone pro du compte
telephone_personnel	Téléphone perso du compte
mdp_decrypte	Le mot de passe décrypté
premium	Crédits SMS premium (défaut 0)
credit_email	Crédits email (défaut 0)
direct_classique	Crédits direct répondeur (défaut 0)
fixe	Minutes fixe (défaut 0)
mobile	Minutes mobile (défaut 0)
fax	Crédits fax (défaut 0)
valider_cgvu	Valider automatiquement les CGVU : 1 ou 0

# Résultats

Résultat	Description
`{resultat: 1, id: 999}`	resultat = 1 = Elément ajouté avec succès
`{resultat: 0, erreur: "Erreur en texte"}`	resultat = 0 = Erreur lors de l'ajout erreur = erreur rencontrée

# Regénérer une clé api

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/regenerer-cle-api

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
id	Id du sous compte à cibler

# Résultats

Résultat	Description
`{resultat: true, cle_api: "2d1a18835cadd5944030bxx"}`	resultat = true = Clé api regénérée avec succès cle_api = nouvelle clé api
`{resultat: false, erreurs: {1,2}`	resultat = false = Erreur lors de la regénération de la clé api du sous compte erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

Numéro	Description
1	Id vide ou sous compte inexistant
2	Le système a rencontré une erreur, merci de nous contacter

# Regénérer plusieurs clés api

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/regenerer-cle-apis

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
ids	Ids des sous compte à cibler sous forme de tableau ou séparés par une virgule

# Résultats

Résultat	Description
`{resultat: true, sub_accounts: {id: {resultat: true, cle_api: "2d1a18835cadd5944030bxx"}}}`	resultat = true = Clées api regénérées avec succès sub_accounts = tableau des sous comptes cle_api = nouvelles clées api
`{resultat: false, sub_accounts: {id: {resultat: false, erreurs: {1,2} }}}`	resultat = false = Erreur lors de la regénération des clées api des sous-comptes sub_accounts = tableau des sous comptes erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

Numéro	Description
1	Id vide ou sous compte inexistant
2	Le système a rencontré une erreur, merci de nous contacter

# Informations

# URL à appeler

https://www.spot-hit.fr/api/sous-compte/informations

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
id	Id du sous compte à cibler

# Résultats

Résultat	Description
`{resultat: 1}`	resultat = 1 = Tableau des données
`{resultat: 0, erreurs: [1,2]}`	resultat = 0 = Erreur lors de la récupération des données erreurs = Tableau des erreurs rencontrées

# Correspondance

Eléments	Description
id	Id du compte ciblé
last_name	Nom
login	Login
email_contact	Email de contact
derniere_co	Dernière connexion
compte_type	Type de compte
dernier_achat	Dernier achat
parent	Parent du sous-compte
suspendu	Indique si le compte est suspendu
credits	Liste des crédits

# Tableau des erreurs

Numéro	Description
1	Id manquant
2	Client introuvable/Pas la permission de modifier le client

← Comptes Liens courts →