Spot-Hit - Documentation API

# Contacts

# Lister les contacts

# URL à appeler

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

# Paramètres

Paramètre Description
key Votre clé API d'identification
format "json" (ou "html", non conseillé)
nbr Optionnel
Le nombre maximum de contacts que vous souhaitez récupérer (ne pas renseigner pour prendre tous les contacts)
groupe Optionnel
Renseigner l'ID d'un de vos groupes si vous souhaitez seulement cibler les contacts présent dans ce groupe

# Résultats


{
    "total":2,
    "colonnes":{"9696":"Prénom","9697":"Nom","27728":"Champs personnalisé"},
    "donnees":
    [
        {"id":"28577127", "numero":"+33600000001","groupe":"30522","email":"[email protected]","fixe":"","fax":"","groupe_nom":"Groupe test",
        "c_champs personnalise":"Contenu champs personnalisé""c_nom":"Nom 1""c_prenom":"Prénom 1"}

        {"id":"28577128","numero":"+33600000002","groupe":"30522","email":"[email protected]","fixe":"","fax":"","groupe_nom":"Groupe test",
        "c_champs personnalise":"Contenu champs personnalisé""c_nom":"Nom 2""c_prenom":"Prénom 2"}
    ]
}

# Ajouter un contact

# URL à appeler

https://www.spot-hit.fr/api/contacts/import

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

contacts[0][nom]=Nom 1
contacts[0][prenom]=Prénom 1
contacts[0][mobile]=+33600000001
contacts[0][fixe]=+33100000001
contacts[0][fax]=+33200000001
contacts[0][email][email protected]
contacts[0][custom_id]=123456
contacts[0][Champs+Personnalise]=Contenu champs personnalisé
contacts[0][Champs+Personnalise+2]=Contenu champs personnalisé
contacts[1][prenom]=Prénom 2
contacts[1][mobile]=+33600000002
contacts[1][fixe]=+33100000002
contacts[1][fax]=+33200000002
contacts[1][email][email protected]
contacts[1][custom_id]=123457
contacts[1][Champs+Personnalise]=Contenu champs personnalisé
contacts[1][Champs+Personnalise+2]=Contenu champs personnalisé
groupe_id ID du groupe dans lequel doivent se situer les contacts
Renseigner 0 si création d'un nouveau groupe
groupe_nom Optionnel
Nom du groupe à créer
groupe_id doit être renseigné à 0
remplacer_groupe Défaut = 0, si égal à 1, remplace les contacts déjà présents dans le groupe
ajouter_autres_groupes Défaut = 0, si égal à 1, ajoute les contacts même si ils sont déjà présents dans un autre groupe
supprimer_internationaux Défaut = 0, si égal à 1, supprime les numéros non Français
indicatif Défaut = 33, (France), indicatif des numéros sans indicatif renseigné

# Résultats

Résultat Description
{resultat: 1, nbr_ajouts: 2, groupe: 1000, contacts_id: {123456478,132465464} resultat = 1 = Elément ajouté avec succès
nbr_ajouts = Nombre contacts ajoutés
groupe = ID du groupe
contacts_id = Liste d'id des contacts ajoutés
{resultat: 0, erreurs: "1,2"} resultat = 0 = Erreur lors de l'import
erreurs = Liste des erreurs rencontrées

# Tableau des erreurs

Numéro Description
1 Impossible de créer le groupe ou groupe déjà existant
2 Contacts vides ou contacts illisibles
3 Le groupe n'existe pas.

# Modifier des contacts

# > À l'unité

# URL à appeler

https://www.spot-hit.fr/api/contacts/edit-contact

Paramètre Description
key Votre clé API d'identification
id ID du contact à modifier
colonnes Tableau avec le nom de la colonne et de la valeur souhaité

Exemple de noms de colonnes :
"mobile"
"fixe"
"email"
"custom_id"
"Champs+Personnalise"
custom_id Mettre à 1 si l'id est personnalisé
groupe Id du groupe afin de cibler l'id personnalisé

# Résultats

Résultat Description
{resultat: true, id : XXX, contact : {colonne : XXX} } resultat = true = Elément modifié avec succès
{resultat: false, erreurs: "Aucune colonne n'a été trouvé", code_erreurs: {1} resultat = false = Erreur lors de la mise à jour du contact
erreurs = Message d'erreur
code_erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

Numéro Description
1 Le contact n'a pas été trouvé
2 Aucune colonne n'a été trouvée
3 Aucun id n'a été renseigné

# > Par lot

# URL à appeler

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

Paramètre Description
key Votre clé API d'identification
contacts Tableau de contacts avec l'id en clé et en valeur un tableau avec le nom de la colonne et de la valeur souhaité
Si une colonne n'existe pas elle ne sera pas créée

Exemple de noms de colonnes :
"mobile"
"fixe"
"email"
"custom_id"
"Champs+Personnalise"
custom_id Mettre à 1 si les ids sont personnalisés
groupe Id du groupe afin de cibler l'id personnalisé

# Résultats

Résultat Description
{ 0: {resultat: true, id : XXX, contact : {colonne : XXX} } } resultat = true = Eléments modifiés avec succès
{ 0: {resultat: false, erreurs: {1,2} } resultat = false = Erreur lors de la mise à jour des contacts
erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

Numéro Description
1 "Contacts" doit être un tableau
2 Aucune colonne n'a été trouvée
3 Aucun id n'a été renseigné
4 Le système à rencontré une erreur, merci de nous contacter.

# Supprimer des contacts

# > À l'unité

# URL à appeler

https://www.spot-hit.fr/api/contact/supprimer

Paramètre Description
key Votre clé API d'identification
id Id du contact à supprimer
custom_id Mettre à 1 si l'id utilisé est un id personnalisé
groupe Id du groupe pour cibler l'id personnalisé

# Résultats

Résultat Description
{resultat: true} resultat = true = Contact supprimé avec succès
{resultat: false, erreurs: {1,2}} resultat = false = Erreur lors de la suppression du contact.
erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

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

# > Par lot

# URL à appeler

https://www.spot-hit.fr/api/contacts/supprimer

Paramètre Description
key Votre clé API d'identification
ids Id des contacts sous forme de tableau ou séparés par une virgule
custom_id Mettre à 1 si les ids utilisés sont des ids personnalisés. (suppression dans tous les groupes)

# Résultats

Résultat Description
{resultat: true, contacts: {id: {'resultat' => true}} resultat = true = Contact supprimé avec succès
contacts = Informations pour chaque contact
{resultat: false, contacts: {id: {'resultat' => false, 'erreurs' => {2}}}} resultat = false = Erreur lors de la suppression du contact
contacts = Informations pour chaque contact
erreurs = Tableau des erreurs rencontrées

# Tableau des erreurs

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

# Colonnes de données

# > Liste des colonnes

# URL à appeler

https://www.spot-hit.fr/api/columns

# Paramètres

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

# Résultats


[ 
  [455] ["Critère 1"] [1] 
  [575]  ["Critère 2"] [2] 
  ...
]

# Correspondance

Eléments Description
[id] Identifiant unique
[nom] Nom de la colonne
[numéro] Numéro de classement des colonnes

# > Ajouter une colonne

# URL à appeler

https://www.spot-hit.fr/api/column/add

# Paramètres

Paramètre Description
key Votre clé API d'identification
nom Nom de la colonne

# Résultats

Résultat Description
{resultat: 1, id: 45498} resultat = 1 = Elément ajouté avec succès.
id = Identifiant unique de l'élément
{resultat: 0, erreurs: "1,2,3,4"} resultat = 0 = Erreur lors de l'ajout
erreurs = Liste des erreurs rencontrées

# Tableau des erreurs

Numéro Description
1 Le nom est vide
2 Le nom contient plus de 11 caractères
3 Nombre de critères limité à 6
4 Le système a rencontré une erreur, merci de nous contacter
5 Le nom de colonne est déjà reservé

# > Modifier une colonne

# URL à appeler

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

# Paramètres

Paramètre Description
key Votre clé API d'identification
nom Nom de la colonne
id ID de la colonne à modifier

# Résultats

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

# Tableau des erreurs

Numéro Description
1 Identifiant inexistant
2 Le nom est vide
3 Le nom contient plus de 11 caractères
4 Le système a rencontré une erreur, merci de nous contacter
5 Le nom de colonne est déjà reservé

# > Supprimer une colonne

# URL à appeler

https://www.spot-hit.fr/api/column/delete

Paramètre Description
key Votre clé API d'identification
id Identifiant de l'élement à supprimer

# Résultats

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

# Tableau des erreurs

Numéro Description
1 Identifiant inexistant
2 Le système a rencontré une erreur, merci de nous contacter

← Contacts : Groupes →

Spot-Hit 2025 © - Documentation officielle - Tous droits réservés