A propos

L'API d'avizi supporte actuellement le format JSON.
Les exemples donnés sont en PHP.

Chaque clé API est limitée à 240 appels par heure. Le code erreur 429 sera retourné si cette limite est atteinte.
Si vous souhaitez que l'on vous propose un accès plus important, merci de nous contacter via admin@avizi.fr en nous précisant la volumétrie attendue.

 Authentification

Toutes les méthodes de l'API nécessitent une authentification.

Pour vous identifier, il vous faudra utiliser "HTTP Basic Authentication", cela consiste à passer les paramètres d'authentification en amont de l’url.
Exemple : https://login:password@app.avizi.fr/api/services/v2/civility

 Filtres et pagination

Pagination : Valeurs par défaut : page = 1, nb_result = 500

Le nombre de résultats retournés par appel est limité à maximum 500. Cette limitation a été mise en place pour éviter les abus. Vous pouvez changer cette valeur en passant le paramètre nb_result dans l'URL d'appel.
Exemple : https://app.avizi.fr/api/services/v2/city/all?page=1&nb_result=15

Filtres :

Certaines méthodes peuvent être filtrées en passant un paramètre dans l'URL d'appel.
Exemple : https://app.avizi.fr/api/services/v2/city/all?city-postal_code=87000

 Campagnes

• • • GET /api/services/v2/campaign/all

      • Recherche toutes les campagnes
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      campaign-id	integer		Filtre sur l'identifiant de la campagne
      campaign-name	string		Filtre sur le nom de la campagne
      campaign-cycle_sejour	boolean		Filtre sur le cycle de séjour
      modecampaign-id	integer		Filtre sur l'identifiant du mode de campagne
      modecampaign-name	string		Filtre sur le nom du mode de campagne

      Retour

      Paramètre	Type	Version	Description
      name	string	>=2.0.0	Nom de la campagne
      cycle_of_stay	boolean	>=2.0.0	Cycle de séjour ?
      mode_campaign[id]	integer	>=2.0.0	Identifiant du mode de campagne
      mode_campaign[name]	string	>=2.0.0	Nom du mode de campagne
      partners[][id]	boolean	>=2.2.0	Identifiant du partenaire à qui appartient la campagne
      partners[][name]	boolean	>=2.2.0	Nom du partenaire à qui appartient la campagne

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/campaign/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/campaign/get/id/{id}

      • Recherche une campagne en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant de la campagne

      Retour

      Paramètre	Type	Version	Description
      name	string	>=2.0.0	Nom de la campagne
      cycle_of_stay	boolean	>=2.0.0	Cycle de séjour ?
      mode_campaign[id]	integer	>=2.0.0	Identifiant du mode de campagne
      mode_campaign[name]	string	>=2.0.0	Nom du mode de campagne
      partners[][id]	boolean	>=2.2.0	Identifiant du partenaire à qui appartient la campagne
      partners[][name]	boolean	>=2.2.0	Nom du partenaire à qui appartient la campagne

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/campaign/get/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/campaign/partners

      • Recherche tous les partenaires des campagnes ciblées (OPT-in)
      • Documentation
      • Exemple

      Retour

      Paramètre	Type	Version	Description
      id	boolean	>=2.2.1	Identifiant du partenaire
      name	boolean	>=2.2.1	Nom du partenaire
      mode_campaign[][id]	boolean	>=2.2.1	Identifiant de mode de campagne
      mode_campaign[][name]	boolean	>=2.2.1	Nom de mode de campagne

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/campaign/partners';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Civilités

• • • GET /api/services/v2/civility/all

      • Recherche toutes les civilités
      • Documentation
      • Exemple

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=1.0.0	Identifiant de la civilité
      title	string	>=1.0.0	Nom de la civilité

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/civility/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/civility/get/{id}

      • Recherche une civilité en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	identifiant de la civilité

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=1.0.0	Identifiant de la civilité
      title	string	>=1.0.0	Nom de la civilité

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/civility/get/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Contacts

• • • PUT /api/services/v2/contact/edit/address/{type}/{search}/{mode}/{value}/{id}

      • Modifie une adresse pour un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché
      id	\d+	integer	Identifiant de l'adresse à modifier

      Paramètres

      Paramètre	Type	Requis	Description
      street	string	Non	Adresse du contact
      postal_code	string	Non	Code postal du contact
      city	string	Non	Ville du contact
      country_number	integer	Oui	Identifiant du pays du contact

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/edit/address/{type}/{search}/{mode}/{value}/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'street' => 'string',
          'postal_code' => 'string',
          'city' => 'string',
          'country_number' => 'integer',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • PUT /api/services/v2/contact/edit/contact/{type}/{search}/{mode}/{value}

      • Modifie les informations d'un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      firstname	string	Non	Prénom du contact
      lastname	string	Non	Nom du contact
      company	string	Non	Raison sociale du contact
      mail	mail	Non	Email du contact
      phone	numeric	Non	Téléphone portable du contact
      fixe	numeric	Non	Téléphone fixe du contact
      title_number	integer	Non	Identifiant de la civilité du contact
      country_number	integer	Non	Identifiant du pays du contact
      language_number	integer	Non	Identifiant de la langue du contact
      optin_mail	boolean	Non	Le contact accepte de recevoir des campagnes emailing ciblées
      optin_sms	boolean	Non	Le contact accepte de recevoir des campagnes SMS ciblées. L'email devient obligatoire (RGPD)
      cycle_of_stay	boolean	Non	Le contact accepte de recevoir des cycles de séjour
      function_number	integer	Non	Identifiant de la fonction du collaborateur (Si is_pro = true)
      profile_number	integer	Non	Identifiant du profil du pro (Si is_pro = true)

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			L'enregistrement du contact a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/edit/contact/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'firstname' => 'string',
          'lastname' => 'string',
          'company' => 'string',
          'mail' => 'mail',
          'phone' => 'numeric',
          'fixe' => 'numeric',
          'title_number' => 'integer',
          'country_number' => 'integer',
          'language_number' => 'integer',
          'optin_mail' => 'boolean',
          'optin_sms' => 'boolean',
          'cycle_of_stay' => 'boolean',
          'function_number' => 'integer',
          'profile_number' => 'integer',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/contact/get-id/{search}

      • Recherche un contact en fonction de identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      search	[a-zA-Z]+	string	Valeur de l'identifiant

      Retour

      Paramètre	Type	Version	Description
      firstname	string	>=1.0.0	Prénom du contact
      lastname	string	>=1.0.0	Nom du contact
      company	string	>=1.0.0	Raison sociale du contact
      mail	string	>=1.0.0	Email du contact
      phone	string	>=1.0.0	Portable du contact
      fixe	string	>=2.2.0	Téléphone fixe du contact
      is_pro	boolean	>=1.0.0	Contact professionnel ?
      cycle_of_stay	boolean	>=2.0.0	Le contact accepte de recevoir des cycles de séjour ?
      addresses[][street]	string	>=1.0.0	Adresse du contact
      addresses[][postal_code]	string	>=1.0.0	Code postal du contact
      addresses[][city]	string	>=1.0.0	Ville du contact
      addresses[][country][id]	integer	>=1.0.0	Identifiant du pays
      addresses[][country][name]	string	>=1.0.0	Nom du pays
      addresses[][country][code]	string	>=1.0.0	Code du pays
      addresses[][type][name]	string	>=2.0.0	Nom du type d'adresse
      civility[id]	integer	>=1.0.0	Identifiant de la civilité
      civility[title]	string	>=1.0.0	Nom de la civilité
      language[name]	string	>=2.2.0	Nom de la langue
      language[code]	string	>=2.2.0	Code de la langue
      campaigns[sms][optin]	boolean	>=2.0.0	Le contact accepte de recevoir des campagnes ciblées SMS
      campaigns[sms][list][][id]	integer	>=2.0.0	Identifiant de la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][list][][name]	string	>=2.0.0	Nom de la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][list][][partner][id]	integer	>=2.2.1	Identifiant du partenaire à qui appartient la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][list][][partner][name]	string	>=2.2.1	Nom du partenaire à qui appartient la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][optin_partner][][id]	integer	>=2.2.1	Identifiant du partenaire (campagnes ciblées SMS) pour lequel le contact est inscrit
      campaigns[sms][optin_partner][][name]	string	>=2.2.1	Nom du partenaire (campagnes ciblées SMS) pour lequel le contact est inscrit
      campaigns[mail][optin]	boolean	>=2.0.0	Le contact accepte de recevoir des campagnes ciblées emailing
      campaigns[mail][list][][id]	integer	>=2.0.0	Identifiant de la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][list][][name]	string	>=2.0.0	Nom de la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][list][][partner][id]	integer	>=2.2.1	Identifiant du partenaire à qui appartient la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][list][][partner][name]	string	>=2.2.1	Nom du partenaire à qui appartient la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][optin_partner][][id]	integer	>=2.2.1	Identifiant du partenaire (campagnes ciblées emailing) pour lequel le contact est inscrit
      campaigns[mail][optin_partner][][name]	string	>=2.2.1	Nom du partenaire (campagnes ciblées emailing) pour lequel le contact est inscrit
      criteria[][criterion][id]	integer	>=2.0.0	Identifiant du critère
      criteria[][criterion][name]	string	>=2.0.0	Nom du critère
      criteria[][modalities][][id]	integer	>=2.0.0	Identifiant de la modalité
      criteria[][modalities][][name]	string	>=2.0.0	Nom de la modalité
      criteria[][modalities][][value]	string	>=2.0.0	Valeur de la modalité

      Codes HTTP

      Code			Description
      200			OK
      404			Object introuvable
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/get-id/{search}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/contact/get/{type}/{search}/{mode}/{value}

      • Recherche un contact en fonction de son email ou téléphone et de son nom de famille ou raison sociale
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Retour

      Paramètre	Type	Version	Description
      firstname	string	>=1.0.0	Prénom du contact
      lastname	string	>=1.0.0	Nom du contact
      company	string	>=1.0.0	Raison sociale du contact
      mail	string	>=1.0.0	Email du contact
      phone	string	>=1.0.0	Portable du contact
      fixe	string	>=2.2.0	Téléphone fixe du contact
      is_pro	boolean	>=1.0.0	Contact professionnel ?
      cycle_of_stay	boolean	>=2.0.0	Le contact accepte de recevoir des cycles de séjour ?
      addresses[][street]	string	>=1.0.0	Adresse du contact
      addresses[][postal_code]	string	>=1.0.0	Code postal du contact
      addresses[][city]	string	>=1.0.0	Ville du contact
      addresses[][country][id]	integer	>=1.0.0	Identifiant du pays
      addresses[][country][name]	string	>=1.0.0	Nom du pays
      addresses[][country][code]	string	>=1.0.0	Code du pays
      addresses[][type][name]	string	>=2.0.0	Nom du type d'adresse
      civility[id]	integer	>=1.0.0	Identifiant de la civilité
      civility[title]	string	>=1.0.0	Nom de la civilité
      language[name]	string	>=2.2.0	Nom de la langue
      language[code]	string	>=2.2.0	Code de la langue
      campaigns[sms][optin]	boolean	>=2.0.0	Le contact accepte de recevoir des campagnes ciblées SMS
      campaigns[sms][list][][id]	integer	>=2.0.0	Identifiant de la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][list][][name]	string	>=2.0.0	Nom de la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][list][][partner][id]	integer	>=2.2.1	Identifiant du partenaire à qui appartient la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][list][][partner][name]	string	>=2.2.1	Nom du partenaire à qui appartient la liste de diffusion SMS à laquelle le contact est inscrit
      campaigns[sms][optin_partner][][id]	integer	>=2.2.1	Identifiant du partenaire (campagnes ciblées SMS) pour lequel le contact est inscrit
      campaigns[sms][optin_partner][][name]	string	>=2.2.1	Nom du partenaire (campagnes ciblées SMS) pour lequel le contact est inscrit
      campaigns[mail][optin]	boolean	>=2.0.0	Le contact accepte de recevoir des campagnes ciblées emailing
      campaigns[mail][list][][id]	integer	>=2.0.0	Identifiant de la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][list][][name]	string	>=2.0.0	Nom de la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][list][][partner][id]	integer	>=2.2.1	Identifiant du partenaire à qui appartient la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][list][][partner][name]	string	>=2.2.1	Nom du partenaire à qui appartient la liste de diffusion emailing à laquelle le contact est inscrit
      campaigns[mail][optin_partner][][id]	integer	>=2.2.1	Identifiant du partenaire (campagnes ciblées emailing) pour lequel le contact est inscrit
      campaigns[mail][optin_partner][][name]	string	>=2.2.1	Nom du partenaire (campagnes ciblées emailing) pour lequel le contact est inscrit
      criteria[][criterion][id]	integer	>=2.0.0	Identifiant du critère
      criteria[][criterion][name]	string	>=2.0.0	Nom du critère
      criteria[][modalities][][id]	integer	>=2.0.0	Identifiant de la modalité
      criteria[][modalities][][name]	string	>=2.0.0	Nom de la modalité
      criteria[][modalities][][value]	string	>=2.0.0	Valeur de la modalité

      Codes HTTP

      Code			Description
      200			OK
      404			Object introuvable
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/get/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/contact/new/address/{type}/{search}/{mode}/{value}

      • Enregistre une nouvelle adresse pour un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      street	string	Non	Adresse du contact
      postal_code	string	Non	Code postal du contact
      city	string	Non	Ville du contact
      country_number	integer	Oui	Identifiant du pays du contact

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/new/address/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'street' => 'string',
          'postal_code' => 'string',
          'city' => 'string',
          'country_number' => 'integer',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/contact/new/campaigns/{type}/{search}/{mode}/{value}

      • Enregistre des nouvelles campagnes pour un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      campaigns	array	Oui	Liste des identifiants des campagnes à ajouter

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/new/campaigns/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'campaigns' => 'array',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/contact/new/contact

      • Enregistre un nouveau contact
      • Documentation
      • Exemple

      Paramètres

      Paramètre	Type	Requis	Description
      firstname	string	Non	Prénom du contact
      lastname	string	Oui	Nom du contact
      company	string	Non	Raison sociale du contact
      street	string	Non	Adresse du contact
      postal_code	string	Non	Code postal du contact
      city	string	Non	Ville du contact
      country_number	integer	Non	Identifiant du pays du contact
      language_number	integer	Non	Identifiant de la langue du contact
      mail	mail	Non	Email du contact
      phone	numeric	Non	Téléphone portable du contact
      fixe	numeric	Non	Téléphone fixe du contact
      title_number	integer	Non	Identifiant de la civilité du contact
      is_pro	boolean	Non	Le contact est-il un pro ? (La raison sociale devient obligatoire)
      function_number	integer	Non	Identifiant de la fonction du collaborateur (Si is_pro = true)
      profile_number	integer	Non	Identifiant du profil du pro (Si is_pro = true)
      optin_mail	boolean	Non	Le contact accepte de recevoir des campagnes emailing ciblées
      optin_sms	boolean	Non	Le contact accepte de recevoir des campagnes SMS ciblées. L'email devient obligatoire (RGPD)
      cycle_of_stay	boolean	Non	Le contact accepte de recevoir des cycles de séjour
      campaigns	array	Non	Liste des identifiants des campagnes auxquelles le contact est abonnées
      optins[][id]	integer	Non	Identifiant du partenaire pour lequel le contact est OPT-in
      optins[][mode_campaign]	integer	Non	Identifiant du mode de campaign pour lequel le contact est OPT-in (2 = emailing, 3 = SMS)
      criteria[][id]	integer	Non	Identifiant de la modalité
      criteria[][value]	string	Non	Valeur de la modalité (Si applicable)

      Codes HTTP

      Code			Description
      200			OK
      400			La syntaxe de la requête est erronée
      500			L'enregistrement du contact a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/new/contact';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'firstname' => 'string',
          'lastname' => 'string',
          'company' => 'string',
          'street' => 'string',
          'postal_code' => 'string',
          'city' => 'string',
          'country_number' => 'integer',
          'language_number' => 'integer',
          'mail' => 'mail',
          'phone' => 'numeric',
          'fixe' => 'numeric',
          'title_number' => 'integer',
          'is_pro' => 'boolean',
          'function_number' => 'integer',
          'profile_number' => 'integer',
          'optin_mail' => 'boolean',
          'optin_sms' => 'boolean',
          'cycle_of_stay' => 'boolean',
          'campaigns' => 'array',
          'optins' => array (
              array (
                  'id' => 'integer',
                  'mode_campaign' => 'integer',
          'criteria' => array (
              array (
                  'id' => 'integer',
                  'value' => 'string',
              )
          )
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/contact/new/criteria/{type}/{search}/{mode}/{value}

      • Enregistre de nouveaux critères pour un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      criteria[][id]	integer	Non	Identifiant de la modalité
      criteria[][value]	string	Non	Valeur de la modalité (Si applicable)

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/new/criteria/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'criteria' => array (
              array (
                  'id' => 'integer',
                  'value' => 'string',
              )
          )
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/contact/new/partners/{type}/{search}/{mode}/{value}

      • Enregistre des nouveaux partenariats pour un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      send_mail	boolean	Non	Envoyer l'email des préférences d'abonnement (Défaut = true)
      optins[][id]	integer	Oui	Identifiant du partenaire à ajouter
      optins[][mode_campaign]	integer	Oui	Identifiant du mode de campaign à ajouter (2 = emailing, 3 = SMS)

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/new/partners/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'send_mail' => 'boolean',
          'optins' => array (
              array (
                  'id' => 'integer',
                  'mode_campaign' => 'integer',
              )
          )
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • DELETE /api/services/v2/contact/remove/campaigns/{type}/{search}/{mode}/{value}

      • Supprime des campagnes d'un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      campaigns	array	Oui	Liste des identifiants des campagnes à supprimer

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/remove/campaigns/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'campaigns' => 'array',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • DELETE /api/services/v2/contact/remove/criteria/{type}/{search}/{mode}/{value}

      • Supprime des critères d'un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      criteria	array	Oui	Liste des identifiants des modalités à supprimer

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/remove/criteria/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'criteria' => 'array',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • DELETE /api/services/v2/contact/remove/partners/{type}/{search}/{mode}/{value}

      • Supprime des partenariats d'un contact (OPT-in)
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      type	[a-zA-Z]+	string	Champ de recherche : phone (Format international : +336XXXXXXXX) ou mail
      search	[a-zA-Z]+	string	Valeur recherchée
      mode	[a-zA-Z]+	string	lastname ou company
      value	[a-zA-Z]+	string	Nom de famille ou raison sociale recherché

      Paramètres

      Paramètre	Type	Requis	Description
      optins[][id]	integer	Oui	Identifiant du partenaire à supprimer
      optins[][mode_campaign]	integer	Oui	Identifiant du mode de campaign à supprimer (2 = emailing, 3 = SMS)

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/contact/remove/partners/{type}/{search}/{mode}/{value}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'optins' => array (
              array (
                  'id' => 'integer',
                  'mode_campaign' => 'integer',
              )
          )
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Conversations

• • • GET /api/services/v2/conversation/modes

      • Liste les modes de conversation
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      modeconversation-id	integer		Filtre sur l'identifiant du type de conversation
      modeconversation-name	string		Filtre sur le nom du type de conversation

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.2.1	Identifiant du mode de conversation
      name	string	>=2.2.1	Nom du mode de conversation

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/conversation/modes';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/conversation/new/conversation

      • Enregistre une nouvelle conversation
      • Documentation
      • Exemple

      Paramètres

      Paramètre	Type	Requis	Description
      contact[external_id]	string	Non	Identifiant externe du contact (Facebook, Apidae, ...)
      contact[firstname]	string	Non	Prénom du contact
      contact[lastname]	string	Oui	Nom du contact
      contact[company]	string	Non	Raison sociale du contact
      contact[street]	string	Non	Adresse du contact
      contact[postal_code]	string	Non	Code postal du contact
      contact[city]	string	Non	Ville du contact
      contact[country_number]	integer	Non	Identifiant du pays du contact
      contact[language_number]	integer	Non	Identifiant de la langue du contact
      contact[mail]	mail	Non	Email du contact
      contact[phone]	numeric	Non	Téléphone portable du contact
      contact[fixe]	numeric	Non	Téléphone fixe du contact
      contact[title_number]	integer	Non	Identifiant de la civilité du contact
      contact[is_pro]	boolean	Non	Le contact est-il un pro ? (La raison sociale devient obligatoire)
      contact[optin_mail]	boolean	Non	Le contact accepte de recevoir des campagnes E-Mailing ciblées
      contact[optin_sms]	boolean	Non	Le contact accepte de recevoir des campagnes SMS ciblées. L'email devient obligatoire (RGPD)
      contact[cycle_of_stay]	boolean	Non	Le contact accepte de recevoir des cycles de séjour
      contact[campaigns]	array	Non	Liste des identifiant des campagnes auxquelles le contact est abonnées
      contact[optins[][id]]	integer	Non	Identifiant du partenaire pour lequel le contact est OPT-in
      contact[optins[][mode_campaign]]	integer	Non	Identifiant du mode de campaign pour lequel le contact est OPT-in (2 = E-Mailing, 3 = SMS)
      contact[criteria[][id]]	integer	Non	Identifiant de la modalité
      contact[criteria[][value]]	string	Non	Valeur de la modalité
      subject	string	Oui	Sujet de la conversation
      comment	string	Non	Commentaire sur la conversation
      evaluation	integer	Non	Evaluation de la conversation
      is_private	boolean	Non	La conversation est-elle privée à l'entité
      mode_id	integer	Oui	Identifiant du mode de conversation
      tags	array	Non	Tag(s) de la conversation
      messages[][content]	string	Oui	Contenu du message
      messages[][send_by_contact]	boolean	Oui	Le message est-il envoyé par le contact ?
      messages[][received_at]	datetime	Oui	Date et heure de réception du message (yyyy-mm-dd hh:mm:ss)

      Codes HTTP

      Code			Description
      200			OK
      400			La syntaxe de la requête est erronée
      500			L'enregistrement du client a échoué L'enregistrement de la conversation a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/conversation/new/conversation';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'contact' => array (
                  'external_id' => 'string',
                  'firstname' => 'string',
                  'lastname' => 'string',
                  'company' => 'string',
                  'street' => 'string',
                  'postal_code' => 'string',
                  'city' => 'string',
                  'country_number' => 'integer',
                  'language_number' => 'integer',
                  'mail' => 'mail',
                  'phone' => 'numeric',
                  'fixe' => 'numeric',
                  'title_number' => 'integer',
                  'is_pro' => 'boolean',
                  'optin_mail' => 'boolean',
                  'optin_sms' => 'boolean',
                  'cycle_of_stay' => 'boolean',
                  'campaigns' => 'array',
                  'optins' => array (
                      array (
                          'id' => 'integer',
                          'mode_campaign' => 'integer',
                  'criteria' => array (
                      array (
                          'id' => 'integer',
                          'value' => 'string',
                      )
                  )
              ),
          'subject' => 'string',
          'comment' => 'string',
          'evaluation' => 'integer',
          'is_private' => 'boolean',
          'mode_id' => 'integer',
          'tags' => 'array',
          'messages' => array (
              array (
                  'content' => 'string',
                  'send_by_contact' => 'boolean',
                  'received_at' => 'datetime',
              )
          )
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Critères

• • • GET /api/services/v2/criterion/all

      • Recherche tous les critères
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      criterion-id	integer		Filtre sur l'identifiant du critère
      criterion-name	string		Filtre sur le nom du critère

      Retour

      Paramètre	Type	Version	Description
      name	string	>=2.0.0	Nom du critère
      type	integer	>=2.0.0	Type du critère
      min_value	integer	>=2.0.0	Valeur minimum du critère
      max_value	integer	>=2.0.0	Valeur maximum du critère
      translations	array	>=2.3.2	Traductions disponibles pour un critère
      criterion_link[id]	integer	>=2.3.0	Identifiant de la liaison critère
      criterion_link[name]	string	>=2.3.0	Nom de la liaison critère
      modalities[][name]	string	>=2.0.0	Nom de la modalité
      modalities[][additional_note]	boolean	>=2.0.0	Note complémentaire disponible ?
      modalities[][translations]	array	>=2.3.2	Traductions disponibles pour une modalité
      link	string	>=2.0.0	Le critère qualifie un contact ou une demande (DEPRECATED)

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/criterion/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/criterion/get/id/{id}

      • Recherche un critère en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant du critère

      Retour

      Paramètre	Type	Version	Description
      name	string	>=2.0.0	Nom du critère
      type	integer	>=2.0.0	Type du critère
      min_value	integer	>=2.0.0	Valeur minimum du critère
      max_value	integer	>=2.0.0	Valeur maximum du critère
      translations	array	>=2.3.2	Traductions disponibles pour un critère
      criterion_link[id]	integer	>=2.3.0	Identifiant de la liaison critère
      criterion_link[name]	string	>=2.3.0	Nom de la liaison critère
      modalities[][name]	string	>=2.0.0	Nom de la modalité
      modalities[][additional_note]	boolean	>=2.0.0	Note complémentaire disponible ?
      modalities[][translations]	array	>=2.3.2	Traductions disponibles pour une modalité
      link	string	>=2.0.0	Le critère qualifie un contact ou une demande (DEPRECATED)

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/criterion/get/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Demandes

• • • GET /api/services/v2/request/all/exchange-mode

      • Recherche tous les modes de contact/réponse
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      exchangemode-id	integer		Filtre sur l'identifiant
      exchangemode-name	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.1.1	Identifiant du mode d'échange
      name	string	>=2.1.1	Nom du mode d'échange

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/request/all/exchange-mode';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/request/all/mode-payment

      • Recherche tous les modes de paiement
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      modepayment-id	integer		Filtre sur l'identifiant
      modepayment-name	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.0.0	Identifiant du mode de paiement
      name	string	>=2.0.0	Nom du mode de paiement

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/request/all/mode-payment';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/request/new/request

      • Enregistre une nouvelle demandes avec un contact
      • Documentation
      • Exemple

      Paramètres

      Paramètre	Type	Requis	Description
      contact[firstname]	string	Non	Prénom du contact
      contact[lastname]	string	Oui	Nom du contact
      contact[company]	string	Non	Raison sociale du contact
      contact[street]	string	Non	Adresse du contact
      contact[postal_code]	string	Non	Code postal du contact
      contact[city]	string	Non	Ville du contact
      contact[country_number]	integer	Non	Identifiant du pays du contact
      contact[language_number]	integer	Non	Identifiant de la langue du contact
      contact[mail]	mail	Non	Email du contact
      contact[phone]	numeric	Non	Téléphone portable du contact
      contact[fixe]	numeric	Non	Téléphone fixe du contact
      contact[title_number]	integer	Non	Identifiant de la civilité du contact
      contact[is_pro]	boolean	Non	Le contact est-il un pro ? (La raison sociale devient obligatoire)
      contact[optin_mail]	boolean	Non	Le contact accepte de recevoir des campagnes emailing ciblées
      contact[optin_sms]	boolean	Non	Le contact accepte de recevoir des campagnes SMS ciblées. L'email devient obligatoire (RGPD)
      contact[cycle_of_stay]	boolean	Non	Le contact accepte de recevoir des cycles de séjour
      contact[campaigns]	array	Non	Liste des identifiants des campagnes auxquelles le contact est abonnées
      contact[optins[][id]]	integer	Non	Identifiant du partenaire pour lequel le contact est OPT-in
      contact[optins[][mode_campaign]]	integer	Non	Identifiant du mode de campaign pour lequel le contact est OPT-in (2 = emailing, 3 = SMS)
      contact[criteria[][id]]	integer	Non	Identifiant de la modalité du contact
      contact[criteria[][value]]	string	Non	Valeur de la modalité du contact (Si applicable)
      thematics	array	Oui	Identifiant des thématique(s) de la demande
      profil_number	integer	Oui	Identifiant du profil pour la demande
      profil_quantity	integer	Non	Nombre de personne pour la demande
      request_country_number	integer	Oui	Identifiant du pays d'origine pour la demande
      contact_number	integer	Oui	Identifiant du mode de contact pour la demande
      response_number	integer	Oui	Identifiant du mode de réponse pour la demande
      visit_date	datetime	Non	Date de visite (yyyy-mm-dd hh:mm:ss). Si vide date et heure de soumission
      presence_start_date	date	Non	Date de début de présence sur le territoire (yyyy-mm-dd)
      presence_end_date	date	Non	Date de fin de présence sur le territoire (yyyy-mm-dd)
      confirmation	boolean	Non	Envoi une confirmation de reception de demande
      private_note	string	Non	Note interne / message (visible uniquement par le personnel de l'office)
      public_note	string	Non	Note publique (note envoyée au contact !)
      mode_payment_number	integer	Non	Identifiant du moyen de paiement (Si applicable)
      payment_status	boolean	Non	La demande est-elle payée ? (Si applicable)
      website_origin	string	Non	URL du site internet où la demande est créée
      sit_locale	string	Non	Locale pour les resultats SIT (FR, EN, DE, NL, ES, IT)
      products[][version_number]	integer	Non	Identifiant de la version du produit
      products[][sit_number]	integer	Non	Identifiant SIT du produit (Si version_number = null)
      products[][sit_type_id]	integer	Non	Identifiant du type de SIT du produit (LEI = 1)
      products[][quantity]	integer	Non	Quantité
      products[][discount]	float	Non	Remise (%) effectuée sur le produit (Si applicable)
      products[][send_mode_number]	integer	Non	Mode d'envoi du produit
      criteria[][id]	integer	Non	Identifiant de la modalité de la demande
      criteria[][value]	string	Non	Valeur de la modalité de la demande (Si applicable)

      Codes HTTP

      Code			Description
      200			OK
      400			La syntaxe de la requête est erronée
      500			L'enregistrement du client a échoué L'enregistrement de la demande a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/request/new/request';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'contact' => array (
                  'firstname' => 'string',
                  'lastname' => 'string',
                  'company' => 'string',
                  'street' => 'string',
                  'postal_code' => 'string',
                  'city' => 'string',
                  'country_number' => 'integer',
                  'language_number' => 'integer',
                  'mail' => 'mail',
                  'phone' => 'numeric',
                  'fixe' => 'numeric',
                  'title_number' => 'integer',
                  'is_pro' => 'boolean',
                  'optin_mail' => 'boolean',
                  'optin_sms' => 'boolean',
                  'cycle_of_stay' => 'boolean',
                  'campaigns' => 'array',
                  'optins' => array (
                      array (
                          'id' => 'integer',
                          'mode_campaign' => 'integer',
                  'criteria' => array (
                      array (
                          'id' => 'integer',
                          'value' => 'string',
                      )
                  )
              ),
          'thematics' => 'array',
          'profil_number' => 'integer',
          'profil_quantity' => 'integer',
          'request_country_number' => 'integer',
          'contact_number' => 'integer',
          'response_number' => 'integer',
          'visit_date' => 'datetime',
          'presence_start_date' => 'date',
          'presence_end_date' => 'date',
          'confirmation' => 'boolean',
          'private_note' => 'string',
          'public_note' => 'string',
          'mode_payment_number' => 'integer',
          'payment_status' => 'boolean',
          'website_origin' => 'string',
          'sit_locale' => 'string',
          'products' => array (
              array (
                  'version_number' => 'integer',
                  'sit_number' => 'integer',
                  'sit_type_id' => 'integer',
                  'quantity' => 'integer',
                  'discount' => 'float',
                  'send_mode_number' => 'integer',
          'criteria' => array (
              array (
                  'id' => 'integer',
                  'value' => 'string',
              )
          )
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/request/send-mode

      • Liste les modes d'envois des documentations
      • Documentation
      • Exemple

      Retour

      Paramètre	Type	Version	Description
      value	string	>=2.1.1	Valeur

      Codes HTTP

      Code			Description
      200			OK
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/request/send-mode';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Disponibilités

• • • GET /api/services/v2/availability/all

      • Recherche toutes les disponibilités
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      availability-start	string		Filtre sur la date de début (yyyy-mm-dd)
      availability-end	string		Filtre sur la date de fin (yyyy-mm-dd)
      availability-last_maj	string		Filtre sur la date de dernière mise à jour (yyyy-mm-dd)

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.3.3	Identifiant de l'objet
      name	string	>=2.3.3	Nom de l'objet
      last_update	string	>=2.3.3	Date de dernière mise à jour
      entity[id]	integer	>=2.3.3	Identifiant de l'entité
      entity[name]	string	>=2.3.3	Nom de l'entité
      availabilities[][date]	boolean	>=2.3.3	Date de la disponibilité
      availabilities[][status][id]	integer	>=2.3.3	Identifiant du statut
      availabilities[][status][name]	string	>=2.3.3	Nom du statut
      availabilities[][quantity]	integer	>=2.3.3	Quantité de la disponibilité

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/availability/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/availability/get-status

      • Recherche tous les statuts des disponibilités
      • Documentation
      • Exemple

      Retour

      Paramètre	Type	Version	Description
      value	string	>=2.3.3	Valeur

      Codes HTTP

      Code			Description
      200			OK
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/availability/get-status';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/availability/get/{id}

      • Recherche les disponibilités en fonction d'un identifiant Apidae
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant

      Filtres

      Name	Type		Description
      availability-start	string		Filtre sur la date de début (yyyy-mm-dd)
      availability-end	string		Filtre sur la date de fin (yyyy-mm-dd)

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.3.3	Identifiant de l'objet
      name	string	>=2.3.3	Nom de l'objet
      last_update	string	>=2.3.3	Date de dernière mise à jour
      entity[id]	integer	>=2.3.3	Identifiant de l'entité
      entity[name]	string	>=2.3.3	Nom de l'entité
      availabilities[][date]	boolean	>=2.3.3	Date de la disponibilité
      availabilities[][status][id]	integer	>=2.3.3	Identifiant du statut
      availabilities[][status][name]	string	>=2.3.3	Nom du statut
      availabilities[][quantity]	integer	>=2.3.3	Quantité de la disponibilité

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/availability/get/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Fonctions

• • • GET /api/services/v2/function/all

      • Recherche toutes les fonctions
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      fonction-id	integer		Filtre sur l'identifiant
      fonction-name	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.0.0	Identifiant de la fonction
      name	string	>=2.0.0	Nom de la fonction

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/function/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/function/get/{id}

      • Recherche une fonction en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant de la fonction

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.0.0	Identifiant de la fonction
      name	string	>=2.0.0	Nom de la fonction

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/function/get/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Langue

• • • GET /api/services/v2/language/all

      • Recherche toutes les langues
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      language-id	integer		Filtre sur l'identifiant
      language-name	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.2.0	Identifiant de la langue
      name	string	>=2.2.0	Nom de la langue
      code	string	>=2.2.0	Code de la langue

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/language/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/language/get/id/{id}

      • Recherche une langue en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	[a-zA-Z]+	string	identifiant de la langue

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.2.0	Identifiant de la langue
      name	string	>=2.2.0	Nom de la langue
      code	string	>=2.2.0	Code de la langue

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/language/get/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Pays

• • • GET /api/services/v2/country/all

      • Recherche tous les pays
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      country-id	integer		Filtre sur l'identifiant
      country-name	string		Filtre sur le nom
      country-code	string		Filtre sur le code

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=1.0.0	Identifiant du pays
      name	string	>=1.0.0	Nom du pays
      code	string	>=1.0.0	Code du pays

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/country/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/country/get/code/{code}

      • Recherche un pays en fonction de son code
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      code	[a-zA-Z]+	string	Code du pays

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=1.0.0	Identifiant du pays
      name	string	>=1.0.0	Nom du pays
      code	string	>=1.0.0	Code du pays

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/country/get/code/{code}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/country/get/id/{id}

      • Recherche un pays en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	[a-zA-Z]+	string	identifiant du pays

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=1.0.0	Identifiant du pays
      name	string	>=1.0.0	Nom du pays
      code	string	>=1.0.0	Code du pays

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/country/get/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Produits

• • • GET /api/services/v2/product/all

      • Recherche tous les produits
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      owner-id	integer		Filtre sur l'identifiant du propriétaire du produit

      Retour

      Paramètre	Type	Version	Description
      versions[][title]	string	>=2.0.0	Titre de la version
      versions[][reference]	string	>=2.0.0	Référence de la version
      versions[][description]	string	>=2.0.0	Description de la version
      versions[][available_from]	DateTime	>=2.0.0	Date de debut de disponibilité
      versions[][available_to]	DateTime	>=2.0.0	Date de fin de disponibilité
      versions[][width]	integer	>=2.0.0	Largeur de la version
      versions[][height]	integer	>=2.0.0	Hauteur de la version
      versions[][weight]	integer	>=2.0.0	Poids de la version
      versions[][thickness]	integer	>=2.0.0	Epaisseur de la version
      versions[][cover]	string	>=2.0.0	Vignette de la version
      versions[][locale]	string	>=2.0.0	Code de la locale
      versions[][quantity]	integer	>=2.0.0	Quantité en stock
      versions[][price]	float	>=2.0.0	Prix du produit
      versions[][paper_version]	boolean	>=2.0.0	Version papier disponible ?
      versions[][tva]	float	>=2.0.0	Taux de TVA
      title	string	>=2.0.0	Titre de la documentation
      thematics[][title]	string	>=2.0.0	Nom de la thématique
      type[id]	integer	>=2.0.0	Identifiant du type de produit
      type[name]	string	>=2.0.0	Nom du type de produit
      owner[id]	string	>=2.2.3	Identifiant du propriétaire du produit
      owner[name]	string	>=2.2.3	Nom du propriétaire du produit
      versions[][file]	string	>=2.0.0	URL de téléchargement du fichier de la version (sans compteur de téléchargement)
      versions[][file_download]	string	>=2.0.0	URL de téléchargement du fichier de la version (avec compteur de téléchargement)
      versions[][file_read]	string	>=2.0.0	URL du lecteur de fichier de la version (avec compteur de lecture)

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/product/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/product/all/types

      • Recherche tous les types de produit
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      typeproduct-id	integer		Filtre sur l'identifiant
      typeproduct-name	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.0.0	Identifiant du type de produit
      name	string	>=2.0.0	Nom du type de produit

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/product/all/types';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/product/get/id/{id}

      • Recherche un produit en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant du produit

      Retour

      Paramètre	Type	Version	Description
      versions[][title]	string	>=2.0.0	Titre de la version
      versions[][reference]	string	>=2.0.0	Référence de la version
      versions[][description]	string	>=2.0.0	Description de la version
      versions[][available_from]	DateTime	>=2.0.0	Date de debut de disponibilité
      versions[][available_to]	DateTime	>=2.0.0	Date de fin de disponibilité
      versions[][width]	integer	>=2.0.0	Largeur de la version
      versions[][height]	integer	>=2.0.0	Hauteur de la version
      versions[][weight]	integer	>=2.0.0	Poids de la version
      versions[][thickness]	integer	>=2.0.0	Epaisseur de la version
      versions[][cover]	string	>=2.0.0	Vignette de la version
      versions[][locale]	string	>=2.0.0	Code de la locale
      versions[][quantity]	integer	>=2.0.0	Quantité en stock
      versions[][price]	float	>=2.0.0	Prix du produit
      versions[][paper_version]	boolean	>=2.0.0	Version papier disponible ?
      versions[][tva]	float	>=2.0.0	Taux de TVA
      title	string	>=2.0.0	Titre de la documentation
      thematics[][title]	string	>=2.0.0	Nom de la thématique
      type[id]	integer	>=2.0.0	Identifiant du type de produit
      type[name]	string	>=2.0.0	Nom du type de produit
      owner[id]	string	>=2.2.3	Identifiant du propriétaire du produit
      owner[name]	string	>=2.2.3	Nom du propriétaire du produit
      versions[][file]	string	>=2.0.0	URL de téléchargement du fichier de la version (sans compteur de téléchargement)
      versions[][file_download]	string	>=2.0.0	URL de téléchargement du fichier de la version (avec compteur de téléchargement)
      versions[][file_read]	string	>=2.0.0	URL du lecteur de fichier de la version (avec compteur de lecture)

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/product/get/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/product/get/version/id/{id}

      • Recherche une version de produit en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant de la version de produit

      Retour

      Paramètre	Type	Version	Description
      versions[][title]	string	>=2.0.0	Titre de la version
      versions[][reference]	string	>=2.0.0	Référence de la version
      versions[][description]	string	>=2.0.0	Description de la version
      versions[][available_from]	DateTime	>=2.0.0	Date de debut de disponibilité
      versions[][available_to]	DateTime	>=2.0.0	Date de fin de disponibilité
      versions[][width]	integer	>=2.0.0	Largeur de la version
      versions[][height]	integer	>=2.0.0	Hauteur de la version
      versions[][weight]	integer	>=2.0.0	Poids de la version
      versions[][thickness]	integer	>=2.0.0	Epaisseur de la version
      versions[][cover]	string	>=2.0.0	Vignette de la version
      versions[][locale]	string	>=2.0.0	Code de la locale
      versions[][quantity]	integer	>=2.0.0	Quantité en stock
      versions[][price]	float	>=2.0.0	Prix du produit
      versions[][paper_version]	boolean	>=2.0.0	Version papier disponible ?
      versions[][tva]	float	>=2.0.0	Taux de TVA
      title	string	>=2.0.0	Titre de la documentation
      thematics[][title]	string	>=2.0.0	Nom de la thématique
      type[id]	integer	>=2.0.0	Identifiant du type de produit
      type[name]	string	>=2.0.0	Nom du type de produit
      owner[id]	string	>=2.2.3	Identifiant du propriétaire du produit
      owner[name]	string	>=2.2.3	Nom du propriétaire du produit
      versions[][file]	string	>=2.0.0	URL de téléchargement du fichier de la version (sans compteur de téléchargement)
      versions[][file_download]	string	>=2.0.0	URL de téléchargement du fichier de la version (avec compteur de téléchargement)
      versions[][file_read]	string	>=2.0.0	URL du lecteur de fichier de la version (avec compteur de lecture)

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/product/get/version/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Profils

• • • GET /api/services/v2/profile/all

      • Recherche tous les profils
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      profile-id	integer		Filtre sur l'identifiant
      profile-name	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.0.0	Identifiant du profil
      name	string	>=2.0.0	Nom du profil

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/profile/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/profile/get/{id}

      • Recherche un profil en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant du profil

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=2.0.0	Identifiant du profil
      name	string	>=2.0.0	Nom du profil

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/profile/get/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Reservations

• • • GET /api/services/v2/reservation/all

      • Recherche toutes les réservations
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      reservation-number	string		Filtre sur le numéro de reservation
      reservationitem-number	string		Filtre sur le numéro d'élèment de reservation
      reservationitem-name	string		Filtre sur le nom d'élèment de reservation
      typereservation-id	integer		Filtre sur l'identifiant du type de réservation
      typereservation-name	string		Filtre sur le nom du type de réservation
      typeprestation-id	integer		Filtre sur l'identifiant du type de prestation
      typeprestation-name	string		Filtre sur le nom du type de prestation

      Retour

      Paramètre	Type	Version	Description
      reservation_number	string	>=1.0.0	Numéro de réservation
      budget	float	>=2.0.0	Budget de la réservation
      reservation_datetime	DateTime	>=1.0.0	Date de la réservation
      contact[firstname]	string	>=1.0.0	Prénom du contact
      contact[lastname]	string	>=1.0.0	Nom du contact
      contact[company]	string	>=1.0.0	Raison sociale du contact
      contact[mail]	string	>=1.0.0	Email du contact
      contact[phone]	string	>=1.0.0	Portable du contact
      contact[fixe]	string	>=2.2.0	Téléphone fixe du contact
      contact[is_pro]	boolean	>=1.0.0	Contact professionnel ?
      contact[cycle_of_stay]	boolean	>=2.0.0	Le contact accepte de recevoir des cycles de séjour ?
      contact[civility][id]	integer	>=1.0.0	Identifiant de la civilité
      contact[civility][title]	string	>=1.0.0	Nom de la civilité
      addresses[][street]	string	>=1.0.0	Adresse du contact
      addresses[][postal_code]	string	>=1.0.0	Code postal du contact
      addresses[][city]	string	>=1.0.0	Ville du contact
      addresses[][country][id]	integer	>=1.0.0	Identifiant du pays
      addresses[][country][name]	string	>=1.0.0	Nom du pays
      addresses[][country][code]	string	>=1.0.0	Code du pays
      addresses[][type][name]	string	>=2.0.0	Nom du type d'adresse
      items[][item_number]	string	>=1.0.0	Numéro du produit
      items[][name]	string	>=1.0.0	Nom du produit
      items[][SIT_number]	integer	>=1.0.0	Fiche SIT lié au produit
      items[][start_date]	DateTime	>=1.0.0	Date de début de la réservation du produit
      items[][end_date]	DateTime	>=1.0.0	Date de fin de la réservation du produit
      items[][postal_code]	string	>=1.0.0	Code postal du produit
      items[][city]	string	>=1.0.0	Ville du produit
      items[][description]	string	>=1.0.0	Description du produit
      items[][price]	float	>=1.0.0	Prix unitaire du produit
      items[][people_number]	integer	>=1.0.0	Nombre de personne de la réservation
      items[][child_number]	integer	>=2.0.0	Nombre d'enfant de la réservation
      items[][quantity]	integer	>=1.1.0	Quantité du produit
      items[][animal]	boolean	>=1.0.0	Animaux présent ?
      items[][breakfast]	boolean	>=1.0.0	Petit déjeuner pour la réservation ?
      items[][type_reservation][id]	integer	>=1.0.0	Identifiant du type de réservation
      items[][type_reservation][name]	string	>=1.0.0	Nom du type de réservation
      items[][type_prestation][id]	integer	>=1.0.0	Identifiant du type de prestation
      items[][type_prestation][name]	string	>=1.0.0	Nom du type de prestation

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/reservation/all-contact/{search}

      • Recherche toutes les réservations d'un contact
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      search	[a-zA-Z]+	string	Valeur de l'identifiant

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      reservation-number	string		Filtre sur le numéro de reservation
      reservationitem-number	string		Filtre sur le numéro d'élèment de reservation
      reservationitem-name	string		Filtre sur le nom d'élèment de reservation
      typereservation-id	integer		Filtre sur l'identifiant du type de réservation
      typereservation-name	string		Filtre sur le nom du type de réservation
      typeprestation-id	integer		Filtre sur l'identifiant du type de prestation
      typeprestation-name	string		Filtre sur le nom du type de prestation

      Retour

      Paramètre	Type	Version	Description
      reservation_number	string	>=1.0.0	Numéro de réservation
      budget	float	>=2.0.0	Budget de la réservation
      reservation_datetime	DateTime	>=1.0.0	Date de la réservation
      contact[firstname]	string	>=1.0.0	Prénom du contact
      contact[lastname]	string	>=1.0.0	Nom du contact
      contact[company]	string	>=1.0.0	Raison sociale du contact
      contact[mail]	string	>=1.0.0	Email du contact
      contact[phone]	string	>=1.0.0	Portable du contact
      contact[fixe]	string	>=2.2.0	Téléphone fixe du contact
      contact[is_pro]	boolean	>=1.0.0	Contact professionnel ?
      contact[cycle_of_stay]	boolean	>=2.0.0	Le contact accepte de recevoir des cycles de séjour ?
      contact[civility][id]	integer	>=1.0.0	Identifiant de la civilité
      contact[civility][title]	string	>=1.0.0	Nom de la civilité
      addresses[][street]	string	>=1.0.0	Adresse du contact
      addresses[][postal_code]	string	>=1.0.0	Code postal du contact
      addresses[][city]	string	>=1.0.0	Ville du contact
      addresses[][country][id]	integer	>=1.0.0	Identifiant du pays
      addresses[][country][name]	string	>=1.0.0	Nom du pays
      addresses[][country][code]	string	>=1.0.0	Code du pays
      addresses[][type][name]	string	>=2.0.0	Nom du type d'adresse
      items[][item_number]	string	>=1.0.0	Numéro du produit
      items[][name]	string	>=1.0.0	Nom du produit
      items[][SIT_number]	integer	>=1.0.0	Fiche SIT lié au produit
      items[][start_date]	DateTime	>=1.0.0	Date de début de la réservation du produit
      items[][end_date]	DateTime	>=1.0.0	Date de fin de la réservation du produit
      items[][postal_code]	string	>=1.0.0	Code postal du produit
      items[][city]	string	>=1.0.0	Ville du produit
      items[][description]	string	>=1.0.0	Description du produit
      items[][price]	float	>=1.0.0	Prix unitaire du produit
      items[][people_number]	integer	>=1.0.0	Nombre de personne de la réservation
      items[][child_number]	integer	>=2.0.0	Nombre d'enfant de la réservation
      items[][quantity]	integer	>=1.1.0	Quantité du produit
      items[][animal]	boolean	>=1.0.0	Animaux présent ?
      items[][breakfast]	boolean	>=1.0.0	Petit déjeuner pour la réservation ?
      items[][type_reservation][id]	integer	>=1.0.0	Identifiant du type de réservation
      items[][type_reservation][name]	string	>=1.0.0	Nom du type de réservation
      items[][type_prestation][id]	integer	>=1.0.0	Identifiant du type de prestation
      items[][type_prestation][name]	string	>=1.0.0	Nom du type de prestation

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/all-contact/{search}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • PUT /api/services/v2/reservation/edit/item/{reservation_number}/{item_number}

      • Modifie les informations d'un produit d'une réservation
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      reservation_number	[a-zA-Z]+	string	Numéro de réservation
      item_number	[a-zA-Z]+	string	Numéro de produit

      Paramètres

      Paramètre	Type	Requis	Description
      name	string	Oui	Nom du produit
      description	string	Non	Description du produit
      SIT_number	string	Non	Fiche SIT lié au produit (LEI)
      start_date	date	Non	Date de début de la réservation (yyyy-mm-dd)
      end_date	date	Oui	Date de fin de la réservation (yyyy-mm-dd)
      postal_code	string	Oui	Code postal du produit
      city	string	Oui	Ville du produit
      price	float	Non	Prix unitaire du produit
      people_number	integer	Non	Nombre de personne
      quantity	integer	Non	Quantité produit
      breakfast	boolean	Non	Petit déjeuner
      animal	boolean	Non	Animaux
      reservation_type_number	integer	Oui	Identifiant du type de réservation
      prestation_type_number	integer	Non	Identifiant du type de prestation

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			L'enregistrement du produit a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/edit/item/{reservation_number}/{item_number}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'name' => 'string',
          'description' => 'string',
          'SIT_number' => 'string',
          'start_date' => 'date',
          'end_date' => 'date',
          'postal_code' => 'string',
          'city' => 'string',
          'price' => 'float',
          'people_number' => 'integer',
          'quantity' => 'integer',
          'breakfast' => 'boolean',
          'animal' => 'boolean',
          'reservation_type_number' => 'integer',
          'prestation_type_number' => 'integer',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • PUT /api/services/v2/reservation/edit/reservation/{reservation_number}

      • Modifie les informations d'une réservation
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      reservation_number	[a-zA-Z]+	string	Numéro de réservation

      Paramètres

      Paramètre	Type	Requis	Description
      reservation_datetime	datetime	Non	Date de réservation (yyyy-mm-dd hh:mm:ss)
      status	integer	Non	Status de la réservation
      budget	float	Non	Budget de la réservation

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			L'enregistrement de la réservation a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/edit/reservation/{reservation_number}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'PUT');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'reservation_datetime' => 'datetime',
          'status' => 'integer',
          'budget' => 'float',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/reservation/get/{reservation_number}

      • Recherche une réservation en fonction de son numéro
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      reservation_number	[a-zA-Z]+	string	Numéro de réservation

      Retour

      Paramètre	Type	Version	Description
      reservation_number	string	>=1.0.0	Numéro de réservation
      budget	float	>=2.0.0	Budget de la réservation
      reservation_datetime	DateTime	>=1.0.0	Date de la réservation
      contact[firstname]	string	>=1.0.0	Prénom du contact
      contact[lastname]	string	>=1.0.0	Nom du contact
      contact[company]	string	>=1.0.0	Raison sociale du contact
      contact[mail]	string	>=1.0.0	Email du contact
      contact[phone]	string	>=1.0.0	Portable du contact
      contact[fixe]	string	>=2.2.0	Téléphone fixe du contact
      contact[is_pro]	boolean	>=1.0.0	Contact professionnel ?
      contact[cycle_of_stay]	boolean	>=2.0.0	Le contact accepte de recevoir des cycles de séjour ?
      contact[civility][id]	integer	>=1.0.0	Identifiant de la civilité
      contact[civility][title]	string	>=1.0.0	Nom de la civilité
      addresses[][street]	string	>=1.0.0	Adresse du contact
      addresses[][postal_code]	string	>=1.0.0	Code postal du contact
      addresses[][city]	string	>=1.0.0	Ville du contact
      addresses[][country][id]	integer	>=1.0.0	Identifiant du pays
      addresses[][country][name]	string	>=1.0.0	Nom du pays
      addresses[][country][code]	string	>=1.0.0	Code du pays
      addresses[][type][name]	string	>=2.0.0	Nom du type d'adresse
      items[][item_number]	string	>=1.0.0	Numéro du produit
      items[][name]	string	>=1.0.0	Nom du produit
      items[][SIT_number]	integer	>=1.0.0	Fiche SIT lié au produit
      items[][start_date]	DateTime	>=1.0.0	Date de début de la réservation du produit
      items[][end_date]	DateTime	>=1.0.0	Date de fin de la réservation du produit
      items[][postal_code]	string	>=1.0.0	Code postal du produit
      items[][city]	string	>=1.0.0	Ville du produit
      items[][description]	string	>=1.0.0	Description du produit
      items[][price]	float	>=1.0.0	Prix unitaire du produit
      items[][people_number]	integer	>=1.0.0	Nombre de personne de la réservation
      items[][child_number]	integer	>=2.0.0	Nombre d'enfant de la réservation
      items[][quantity]	integer	>=1.1.0	Quantité du produit
      items[][animal]	boolean	>=1.0.0	Animaux présent ?
      items[][breakfast]	boolean	>=1.0.0	Petit déjeuner pour la réservation ?
      items[][type_reservation][id]	integer	>=1.0.0	Identifiant du type de réservation
      items[][type_reservation][name]	string	>=1.0.0	Nom du type de réservation
      items[][type_prestation][id]	integer	>=1.0.0	Identifiant du type de prestation
      items[][type_prestation][name]	string	>=1.0.0	Nom du type de prestation

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/get/{reservation_number}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/reservation/get/{reservation_number}/{item_number}

      • Recherche un produit d'une réservation en fonction du numéro de réservation et du numéro de produit
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      reservation_number	[a-zA-Z]+	string	Numéro de réservation
      item_number	[a-zA-Z]+	string	Numéro de produit

      Retour

      Paramètre	Type	Version	Description
      reservation_number	string	>=1.0.0	Numéro de réservation
      budget	float	>=2.0.0	Budget de la réservation
      reservation_datetime	DateTime	>=1.0.0	Date de la réservation
      contact[firstname]	string	>=1.0.0	Prénom du contact
      contact[lastname]	string	>=1.0.0	Nom du contact
      contact[company]	string	>=1.0.0	Raison sociale du contact
      contact[mail]	string	>=1.0.0	Email du contact
      contact[phone]	string	>=1.0.0	Portable du contact
      contact[fixe]	string	>=2.2.0	Téléphone fixe du contact
      contact[is_pro]	boolean	>=1.0.0	Contact professionnel ?
      contact[cycle_of_stay]	boolean	>=2.0.0	Le contact accepte de recevoir des cycles de séjour ?
      contact[civility][id]	integer	>=1.0.0	Identifiant de la civilité
      contact[civility][title]	string	>=1.0.0	Nom de la civilité
      addresses[][street]	string	>=1.0.0	Adresse du contact
      addresses[][postal_code]	string	>=1.0.0	Code postal du contact
      addresses[][city]	string	>=1.0.0	Ville du contact
      addresses[][country][id]	integer	>=1.0.0	Identifiant du pays
      addresses[][country][name]	string	>=1.0.0	Nom du pays
      addresses[][country][code]	string	>=1.0.0	Code du pays
      addresses[][type][name]	string	>=2.0.0	Nom du type d'adresse
      items[][item_number]	string	>=1.0.0	Numéro du produit
      items[][name]	string	>=1.0.0	Nom du produit
      items[][SIT_number]	integer	>=1.0.0	Fiche SIT lié au produit
      items[][start_date]	DateTime	>=1.0.0	Date de début de la réservation du produit
      items[][end_date]	DateTime	>=1.0.0	Date de fin de la réservation du produit
      items[][postal_code]	string	>=1.0.0	Code postal du produit
      items[][city]	string	>=1.0.0	Ville du produit
      items[][description]	string	>=1.0.0	Description du produit
      items[][price]	float	>=1.0.0	Prix unitaire du produit
      items[][people_number]	integer	>=1.0.0	Nombre de personne de la réservation
      items[][child_number]	integer	>=2.0.0	Nombre d'enfant de la réservation
      items[][quantity]	integer	>=1.1.0	Quantité du produit
      items[][animal]	boolean	>=1.0.0	Animaux présent ?
      items[][breakfast]	boolean	>=1.0.0	Petit déjeuner pour la réservation ?
      items[][type_reservation][id]	integer	>=1.0.0	Identifiant du type de réservation
      items[][type_reservation][name]	string	>=1.0.0	Nom du type de réservation
      items[][type_prestation][id]	integer	>=1.0.0	Identifiant du type de prestation
      items[][type_prestation][name]	string	>=1.0.0	Nom du type de prestation

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/get/{reservation_number}/{item_number}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/reservation/new/item/{reservation_number}

      • Enregistre un nouveau produit pour une réservation
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      reservation_number	[a-zA-Z]+	string	Numéro de réservation

      Paramètres

      Paramètre	Type	Requis	Description
      item_number	string	Oui	Numéro de produit
      name	string	Oui	Nom du produit
      description	string	Non	Description du produit
      SIT_number	string	Non	Fiche SIT lié au produit (LEI)
      start_date	date	Non	Date de début de la réservation (yyyy-mm-dd)
      end_date	date	Oui	Date de fin de la réservation (yyyy-mm-dd)
      postal_code	string	Oui	Code postal du produit
      city	string	Oui	Ville du produit
      price	float	Non	Prix unitaire du produit
      people_number	integer	Non	Nombre de personne
      quantity	integer	Non	Quantité produit
      breakfast	boolean	Non	Petit déjeuner
      animal	boolean	Non	Animaux
      reservation_type_number	integer	Oui	Identifiant du type de réservation
      prestation_type_number	integer	Non	Identifiant du type de prestation

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			L'enregistrement du produit a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/new/item/{reservation_number}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'item_number' => 'string',
          'name' => 'string',
          'description' => 'string',
          'SIT_number' => 'string',
          'start_date' => 'date',
          'end_date' => 'date',
          'postal_code' => 'string',
          'city' => 'string',
          'price' => 'float',
          'people_number' => 'integer',
          'quantity' => 'integer',
          'breakfast' => 'boolean',
          'animal' => 'boolean',
          'reservation_type_number' => 'integer',
          'prestation_type_number' => 'integer',
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • POST /api/services/v2/reservation/new/reservation

      • Enregistre une nouvelle réservation
      • Documentation
      • Exemple

      Paramètres

      Paramètre	Type	Requis	Description
      contact[firstname]	string	Non	Prénom du contact
      contact[lastname]	string	Oui	Nom du contact
      contact[company]	string	Non	Raison sociale du contact
      contact[street]	string	Non	Adresse du contact
      contact[postal_code]	string	Non	Code postal du contact
      contact[city]	string	Non	Ville du contact
      contact[country_number]	integer	Non	Identifiant du pays du contact
      contact[language_number]	integer	Non	Identifiant de la langue du contact
      contact[mail]	mail	Non	Email du contact
      contact[phone]	numeric	Non	Téléphone portable du contact
      contact[fixe]	numeric	Non	Téléphone fixe du contact
      contact[title_number]	integer	Non	Identifiant de la civilité du contact
      contact[is_pro]	boolean	Non	Le contact est-il un pro ? (La raison sociale devient obligatoire)
      function_number	integer	Non	Identifiant de la fonction du collaborateur (Si is_pro = true)
      profile_number	integer	Non	Identifiant du profil du pro (Si is_pro = true)
      contact[optin_mail]	boolean	Non	Le contact accepte de recevoir des campagnes emailing ciblées
      contact[optin_sms]	boolean	Non	Le contact accepte de recevoir des campagnes SMS ciblées. L'email devient obligatoire (RGPD)
      contact[cycle_of_stay]	boolean	Non	Le contact accepte de recevoir des cycles de séjour
      contact[campaigns]	array	Non	Liste des identifiants des campagnes auxquelles le contact est abonnées
      contact[optins[][id]]	integer	Non	Identifiant du partenaire pour lequel le contact est OPT-in
      contact[optins[][mode_campaign]]	integer	Non	Identifiant du mode de campaign pour lequel le contact est OPT-in (2 = emailing, 3 = SMS)
      contact[criteria[][id]]	integer	Non	Identifiant de la modalité
      contact[criteria[][value]]	string	Non	Valeur de la modalité
      reservation_number	string	Oui	Numéro de la réservation
      budget	float	Non	Budget de la réservation
      status	integer	Non	Status de la réservation
      reservation_datetime	datetime	Non	Date de réservation (yyyy-mm-dd hh:mm:ss)
      items[][item_number]	string	Oui	Numéro de produit
      items[][name]	string	Oui	Nom du produit
      items[][description]	string	Non	Description du produit
      items[][SIT_number]	string	Non	Fiche SIT lié au produit (LEI)
      items[][start_date]	date	Oui	Date de début de la réservation (yyyy-mm-dd)
      items[][end_date]	date	Oui	Date de fin de la réservation (yyyy-mm-dd)
      items[][postal_code]	string	Non	Code postal du produit
      items[][city]	string	Non	Ville du produit
      items[][price]	float	Non	Prix unitaire du produit
      items[][people_number]	integer	Non	Nombre de personne
      items[][child_number]	integer	Non	Nombre d'enfant
      items[][quantity]	integer	Non	Quantité produit
      items[][breakfast]	boolean	Non	Petit déjeuner
      items[][animal]	boolean	Non	Animaux
      items[][reservation_type_number]	integer	Oui	Identifiant du type de réservation
      items[][prestation_type_number]	integer	Non	Identifiant du type de prestation

      Codes HTTP

      Code			Description
      200			OK
      400			La syntaxe de la requête est erronée
      500			L'enregistrement du client a échoué L'enregistrement de la réservation a échoué L'enregistrement du produit a échoué Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/new/reservation';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Définition des paramètres
      $data = array(
          'contact' => array (
                  'firstname' => 'string',
                  'lastname' => 'string',
                  'company' => 'string',
                  'street' => 'string',
                  'postal_code' => 'string',
                  'city' => 'string',
                  'country_number' => 'integer',
                  'language_number' => 'integer',
                  'mail' => 'mail',
                  'phone' => 'numeric',
                  'fixe' => 'numeric',
                  'title_number' => 'integer',
                  'is_pro' => 'boolean',
          'function_number' => 'integer',
          'profile_number' => 'integer',
                  'optin_mail' => 'boolean',
                  'optin_sms' => 'boolean',
                  'cycle_of_stay' => 'boolean',
                  'campaigns' => 'array',
                  'optins' => array (
                      array (
                          'id' => 'integer',
                          'mode_campaign' => 'integer',
                  'criteria' => array (
                      array (
                          'id' => 'integer',
                          'value' => 'string',
                      )
                  )
              ),
          'reservation_number' => 'string',
          'budget' => 'float',
          'status' => 'integer',
          'reservation_datetime' => 'datetime',
          'items' => array (
              array (
                  'item_number' => 'string',
                  'name' => 'string',
                  'description' => 'string',
                  'SIT_number' => 'string',
                  'start_date' => 'date',
                  'end_date' => 'date',
                  'postal_code' => 'string',
                  'city' => 'string',
                  'price' => 'float',
                  'people_number' => 'integer',
                  'child_number' => 'integer',
                  'quantity' => 'integer',
                  'breakfast' => 'boolean',
                  'animal' => 'boolean',
                  'reservation_type_number' => 'integer',
                  'prestation_type_number' => 'integer',
              )
          )
      );
      
      // Convertion du tableau en JSON
      $dataJson = json_encode($data);
      
      // Ajout des paramètres
      curl_setopt($curl, CURLOPT_POSTFIELDS, $dataJson);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: '.strlen($dataJson))
      );
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • DELETE /api/services/v2/reservation/remove/item/{reservation_number}/{item_number}

      • Supprime un produit d'une réservation
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      reservation_number	[a-zA-Z]+	string	Numéro de réservation
      item_number	[a-zA-Z]+	string	Numéro de produit

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/remove/item/{reservation_number}/{item_number}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • DELETE /api/services/v2/reservation/remove/reservation/{reservation_number}

      • Supprime une réservation
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      reservation_number	[a-zA-Z]+	string	Numéro de réservation

      Codes HTTP

      Code			Description
      200			OK
      404			Objet introuvable
      400			La syntaxe de la requête est erronée
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/remove/reservation/{reservation_number}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/reservation/status

      • Liste les statuts de réservations disponibles
      • Documentation
      • Exemple

      Retour

      Paramètre	Type	Version	Description
      value	string	>=1.0.0	Valeur du statut

      Codes HTTP

      Code			Description
      200			OK
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/status';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/reservation/types

      • Liste les types de réservations et prestations disponibles
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      typereservation-id	integer		Filtre sur l'identifiant du type de réservation
      typereservation-name	string		Filtre sur le nom du type de réservation
      typeprestation-id	integer		Filtre sur l'identifiant du type de prestation
      typeprestation-name	string		Filtre sur le nom du type de prestation

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=1.0.0	Identifiant du type de réservation
      name	string	>=1.0.0	Nom du type de réservation

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/reservation/types';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Thématisations

• • • GET /api/services/v2/tag/all

      • Recherche tous les tags
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      tag-id	integer		Filtre sur l'identifiant
      tag-title	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      name	string	>=2.1.1	Nom du tag
      regional	boolean	>=2.1.1	Tag régional ?
      type[id]	integer	>=2.1.1	Identifiant du type de tag
      type[name]	string	>=2.1.1	Nom du type de tag
      thematics[][title]	string	>=2.0.0	Nom de la thématique

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/tag/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/tag/get/id/{id}

      • Recherche un tag en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant du tag

      Retour

      Paramètre	Type	Version	Description
      name	string	>=2.1.1	Nom du tag
      regional	boolean	>=2.1.1	Tag régional ?
      type[id]	integer	>=2.1.1	Identifiant du type de tag
      type[name]	string	>=2.1.1	Nom du type de tag
      thematics[][title]	string	>=2.0.0	Nom de la thématique

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/tag/get/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/thematic/all

      • Recherche toutes les thématiques
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      thematic-id	integer		Filtre sur l'identifiant
      thematic-title	string		Filtre sur le nom

      Retour

      Paramètre	Type	Version	Description
      title	string	>=2.0.0	Nom de la thématique
      tags[][name]	string	>=2.1.1	Nom du tag
      tags[][regional]	boolean	>=2.1.1	Tag régional ?
      tags[][type][id]	integer	>=2.1.1	Identifiant du type de tag
      tags[][type][name]	string	>=2.1.1	Nom du type de tag
      [parent][id]	integer	>=2.0.0	Identifiant de la thématique parente
      [parent][title]	string	>=2.0.0	Nom de la thématique parente

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/thematic/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

    • GET /api/services/v2/thematic/get/id/{id}

      • Recherche une thématique en fonction de son identifiant
      • Documentation
      • Exemple

      Requis

      Nom	Format	Type	Description
      id	\d+	integer	Identifiant de la thematique

      Retour

      Paramètre	Type	Version	Description
      title	string	>=2.0.0	Nom de la thématique
      tags[][name]	string	>=2.1.1	Nom du tag
      tags[][regional]	boolean	>=2.1.1	Tag régional ?
      tags[][type][id]	integer	>=2.1.1	Identifiant du type de tag
      tags[][type][name]	string	>=2.1.1	Nom du type de tag
      [parent][id]	integer	>=2.0.0	Identifiant de la thématique parente
      [parent][title]	string	>=2.0.0	Nom de la thématique parente

      Codes HTTP

      Code			Description
      200			OK
      404			Identifiant introuvable
      500			La syntaxe de la requête est erronée

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/thematic/get/id/{id}';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);
      

 Villes

• • • GET /api/services/v2/city/all

      • Recherche toutes les villes
      • Documentation
      • Exemple

      Filtres

      Name	Type		Description
      page	integer		Numéro de page
      nb_result	integer		Nombre de résultats par page
      city-id	integer		Filtre sur l'identifiant de la ville
      city-name	string		Filtre sur le nom de la ville
      city-postal_code	string		Filtre sur le code postal de la ville
      country-id	integer		Filtre sur l'identifiant du pays
      country-name	string		Filtre sur le nom du pays
      country-code	string		Filtre sur le code du pays

      Retour

      Paramètre	Type	Version	Description
      id	integer	>=1.1.0	Identifiant de la vile
      name	string	>=1.1.0	Nom de la ville
      postal_code	string	>=1.1.0	Code postal de la ville
      country[id]	integer	>=1.0.0	Identifiant du pays
      country[name]	string	>=1.0.0	Nom du pays
      country[code]	string	>=1.0.0	Code du pays

      Codes HTTP

      Code			Description
      200			OK Aucun résultat
      500			Erreur inconnue

      // Ouvre la connexion cURL
      $curl = curl_init();
      
      // URL d'appel
      $url = 'https://login:password@app.avizi.fr/api/services/v2/city/all';
      
      // Gestion de l'URL, de la méthode HTTP et du retour
      curl_setopt($curl, CURLOPT_URL, $url);
      curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      
      // Execute la requête cURL
      $response = curl_exec($curl);
      
      // Affichage du résultat
      print_r($response);
      
      // Ferme la connexion cURL
      curl_close($curl);