Ventilo API (1.0)

Download OpenAPI specification:Download

API documentation for the Ventilo management system.

CRM

Gestionnaire des contacts et des organisations

Liste des contacts

path Parameters

limit

integer

Default: 100

Le nombre maximum de contacts à récupérer

Responses

Response samples

200
404

Content type

application/json

[{"contact_idx": "string",
"contact_updated": "string",
"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "string",
"contact_note": "string",
"contact_created": "string",
"contact_activate": "string",
"organisations": [{"organisation_idx": "string",
"organisation_city": "string",
"organisation_note": "string",
"organisation_type": "string",
"organisation_country": "string",
"organisation_created": "string",
"organisation_email_1": "string",
"organisation_email_2": "string",
"organisation_updated": "string",
"organisation_website": "string",
"organisation_zipcode": "string",
"organisation_enseigne": "string",
"organisation_mobile_1": "string",
"organisation_mobile_2": "string",
"organisation_address_1": "string",
"organisation_address_2": "string",
"organisation_raison_sociale": "string",
"organisation_telephone_fixe": "string",
"organisation_telephone_domicile": "string"
}
],
"tags": [{"tag_name": "string"
}
]
}
]

Contact par Idx

path Parameters

contact_idx

required

string

Responses

Response samples

200
404

Content type

application/json

{"contact_idx": "string",
"contact_updated": "2019-08-24T14:15:22Z",
"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "string",
"contact_note": "string",
"contact_created": "2019-08-24T14:15:22Z",
"contact_activate": "string",
"organisations": [{"organisation_idx": "string",
"organisation_city": "string",
"organisation_note": "string",
"organisation_type": "string",
"organisation_country": "string",
"organisation_created": "2019-08-24T14:15:22Z",
"organisation_email_1": "string",
"organisation_email_2": "string",
"organisation_updated": "2019-08-24T14:15:22Z",
"organisation_website": "string",
"organisation_zipcode": "string",
"organisation_enseigne": "string",
"organisation_mobile_1": "string",
"organisation_mobile_2": "string",
"organisation_address_1": "string",
"organisation_address_2": "string",
"organisation_raison_sociale": "string",
"organisation_telephone_fixe": "string",
"organisation_telephone_domicile": "string"
}
],
"tags": [{"tag_name": "string"
}
]
}

Ajout d'un contact

Request Body schema: application/json

contact_gender	string or null
contact_lastname required	string
contact_firstname required	string
contact_fonction	string or null
contact_email_perso	string or null
contact_email_pro	string or null
contact_mobile_1	string or null
contact_mobile_2	string or null
contact_telephone_fixe	string or null
contact_telephone_domicile	string or null
contact_address_1	string or null
contact_address_2	string or null
contact_zipcode	string or null
contact_city	string or null
contact_country	string or null
contact_birthday	string or null <date>
contact_note	string or null
contact_created	string or null <date-time>
contact_activate	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "2019-08-24",
"contact_note": "string",
"contact_created": "2019-08-24T14:15:22Z",
"contact_activate": true
}

Response samples

201
400

Content type

application/json

{"status": "success",
"data": {"contact_idx": "string",
"contact_updated": "2019-08-24T14:15:22Z",
"contact_vcard_uid": "string",
"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe_old": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile_old": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "2019-08-24",
"contact_note": "string",
"contact_created": "2019-08-24T14:15:22Z",
"contact_activate": true
}
}

Mettre à jour un contact

Request Body schema: application/json

contact_idx	string
contact_gender	string or null
contact_lastname	string
contact_firstname	string
contact_fonction	string or null
contact_email_perso	string or null
contact_email_pro	string or null
contact_mobile_1	string or null
contact_mobile_2	string or null
contact_telephone_fixe	string or null
contact_telephone_domicile	string or null
contact_address_1	string or null
contact_address_2	string or null
contact_zipcode	string or null
contact_city	string or null
contact_country	string or null
contact_birthday	string or null <date>
contact_note	string or null
contact_created	string or null <date-time>
contact_activate	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"contact_idx": "string",
"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "2019-08-24",
"contact_note": "string",
"contact_created": "2019-08-24T14:15:22Z",
"contact_activate": true
}

Response samples

200
400

Content type

application/json

{"status": "success",
"data": {"contact_idx": "string",
"contact_updated": "2019-08-24T14:15:22Z",
"contact_vcard_uid": "string",
"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe_old": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile_old": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "2019-08-24",
"contact_note": "string",
"contact_created": "2019-08-24T14:15:22Z",
"contact_activate": true
}
}

Supprimer un contact

path Parameters

contact_idx

required

string

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Contact deleted successfully"
}

Rechercher des contacts

Recherche des contacts associés à l'utilisateur connecté en fonction d'un mot-clé donné.

query Parameters

word

required

string

Le mot-clé à rechercher

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "result of your research",
"data": [{"contact_idx": "e1b1cec8f56cdc18",
"contact_updated": null,
"contact_gender": "M.",
"contact_lastname": "ala st5",
"contact_firstname": "first5",
"contact_fonction": "",
"contact_email_perso": "",
"contact_email_pro": "",
"contact_mobile_1_prefix": "33",
"contact_mobile_1": "6 24 32 37 41",
"contact_mobile_2_prefix": "33",
"contact_mobile_2": "6 24 32 37 41",
"contact_telephone_fixe_prefix": "504",
"contact_telephone_fixe": "2 33322",
"contact_telephone_domicile_prefix": "39",
"contact_telephone_domicile": "666798798",
"contact_address_1": "",
"contact_address_2": "",
"contact_zipcode": "",
"contact_city": "",
"contact_country": "",
"contact_birthday": "",
"contact_note": "",
"contact_created": null,
"contact_activate": null,
"organisations": [{"organisation_idx": "f7558d25090fb5bc",
"organisation_city": null,
"organisation_note": null,
"organisation_type": "entreprise",
"organisation_country": null,
"organisation_created": null,
"organisation_email_1": null,
"organisation_email_2": null,
"organisation_updated": null,
"organisation_website": null,
"organisation_zipcode": null,
"organisation_enseigne": null,
"organisation_mobile_1": null,
"organisation_mobile_2": null,
"organisation_address_1": null,
"organisation_address_2": null,
"organisation_raison_sociale": "a orga3",
"organisation_telephone_fixe": null,
"organisation_mobile_1_prefix": null,
"organisation_mobile_2_prefix": null,
"organisation_telephone_domicile": null,
"organisation_telephone_fixe_prefix": null,
"organisation_telephone_domicile_prefix": null
}
],
"tags": [{"tag_idx": "7cb88539c724896c",
"tag_name": "totos"
}
]
}
]
}

Ajouter un contact à une organisation

Request Body schema: application/json

contact_idx required	string
organisation_idx required	string

Responses

Request samples

Payload

Content type

application/json

{"contact_idx": "123",
"organisation_idx": "456"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Contact organisation created successfully"
}

Retirer un contact d'une organisation

Request Body schema: application/json

contact_idx required	string
organisation_idx required	string

Responses

Request samples

Payload

Content type

application/json

{"contact_idx": "123",
"organisation_idx": "456"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Contact organisation deleted successfully"
}

Ajouter un tag à un contact

Request Body schema: application/json

contact_idx required	integer
tag_name required	string

Responses

Request samples

Payload

Content type

application/json

{"contact_idx": 1,
"tag_name": "Important"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Contact tag created successfully"
}

Retirer un tag à un contact

path Parameters

contact_idx required	integer ID of the contact
tag_idx required	integer ID of the tag

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Contact tag deleted successfully"
}

Créer une organisation

Request Body schema: application/json

organisation_raison_sociale required	string
organisation_type required	string
organisation_enseigne	string
organisation_email_1	string
organisation_email_2	string
organisation_mobile_1	string
organisation_mobile_2	string
organisation_telephone_fixe	string
organisation_telephone_domicile	string
organisation_website	string
organisation_address_1	string
organisation_address_2	string
organisation_zipcode	string
organisation_city	string
organisation_country	string
organisation_siret	string
organisation_note	string

Responses

Request samples

Payload

Content type

application/json

{"organisation_raison_sociale": "string",
"organisation_type": "string",
"organisation_enseigne": "string",
"organisation_email_1": "string",
"organisation_email_2": "string",
"organisation_mobile_1": "string",
"organisation_mobile_2": "string",
"organisation_telephone_fixe": "string",
"organisation_telephone_domicile": "string",
"organisation_website": "string",
"organisation_address_1": "string",
"organisation_address_2": "string",
"organisation_zipcode": "string",
"organisation_city": "string",
"organisation_country": "string",
"organisation_siret": "string",
"organisation_note": "string"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Organisation created successfully",
"organisation_idx": "f7558d25090fb5bc"
}

Liste des organisations

path Parameters

limit

integer

Default: 100

Le nombre maximum d'organisations à récupérer

Responses

Response samples

200
404

Content type

application/json

[{"organisation_idx": "string",
"organisation_city": "string",
"organisation_note": "string",
"organisation_type": "string",
"organisation_country": "string",
"organisation_created": "string",
"organisation_email_1": "string",
"organisation_email_2": "string",
"organisation_updated": "string",
"organisation_website": "string",
"organisation_zipcode": "string",
"organisation_enseigne": "string",
"organisation_mobile_1": "string",
"organisation_mobile_2": "string",
"organisation_address_1": "string",
"organisation_address_2": "string",
"organisation_raison_sociale": "string",
"organisation_siret": "string",
"organisation_telephone_fixe": "string",
"organisation_telephone_domicile": "string",
"contacts": [{"contact_idx": "string",
"contact_updated": "string",
"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1_prefix": "string",
"contact_mobile_1": "string",
"contact_mobile_2_prefix": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe_prefix": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile_prefix": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "string",
"contact_note": "string",
"contact_created": "string",
"contact_activate": true
}
]
}
]

Organisation par Idx

path Parameters

organisation_idx

required

string

Responses

Response samples

200
404

Content type

application/json

{"organisation_idx": "string",
"organisation_raison_sociale": "string",
"organisation_type": "string",
"organisation_enseigne": "string",
"organisation_email_1": "string",
"organisation_email_2": "string",
"organisation_mobile_1": "string",
"organisation_mobile_1_prefix": "string",
"organisation_mobile_2": "string",
"organisation_mobile_2_prefix": "string",
"organisation_telephone_fixe": "string",
"organisation_telephone_fixe_prefix": "string",
"organisation_telephone_domicile": "string",
"organisation_telephone_domicile_prefix": "string",
"organisation_website": "string",
"organisation_address_1": "string",
"organisation_address_2": "string",
"organisation_zipcode": "string",
"organisation_city": "string",
"organisation_country": "string",
"organisation_siret": "string",
"organisation_note": "string",
"contacts": [{"contact_idx": "string",
"contact_updated": "string",
"contact_gender": "string",
"contact_lastname": "string",
"contact_firstname": "string",
"contact_fonction": "string",
"contact_email_perso": "string",
"contact_email_pro": "string",
"contact_mobile_1_prefix": "string",
"contact_mobile_1": "string",
"contact_mobile_2_prefix": "string",
"contact_mobile_2": "string",
"contact_telephone_fixe_prefix": "string",
"contact_telephone_fixe": "string",
"contact_telephone_domicile_prefix": "string",
"contact_telephone_domicile": "string",
"contact_address_1": "string",
"contact_address_2": "string",
"contact_zipcode": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "string",
"contact_note": "string",
"contact_created": "string",
"contact_activate": true
}
]
}

Mettre à jour une organisation

path Parameters

organisation_idx

required

string

Request Body schema: application/json

organisation_raison_sociale	string
organisation_type	string
organisation_enseigne	string
organisation_email_1	string
organisation_email_2	string
organisation_mobile_1	string
organisation_mobile_2	string
organisation_telephone_fixe	string
organisation_telephone_domicile	string
organisation_website	string
organisation_address_1	string
organisation_address_2	string
organisation_zipcode	string
organisation_city	string
organisation_country	string
organisation_siret	string
organisation_note	string

Responses

Request samples

Payload

Content type

application/json

{"organisation_raison_sociale": "string",
"organisation_type": "string",
"organisation_enseigne": "string",
"organisation_email_1": "string",
"organisation_email_2": "string",
"organisation_mobile_1": "string",
"organisation_mobile_2": "string",
"organisation_telephone_fixe": "string",
"organisation_telephone_domicile": "string",
"organisation_website": "string",
"organisation_address_1": "string",
"organisation_address_2": "string",
"organisation_zipcode": "string",
"organisation_city": "string",
"organisation_country": "string",
"organisation_siret": "string",
"organisation_note": "string"
}

Response samples

200
400

Content type

application/json

{"status": "string",
"message": "string"
}

Supprimer une organisation

path Parameters

organisation_idx

required

string

Responses

Response samples

200
400

Content type

application/json

{"status": "string",
"message": "string"
}

Rechercher une organisation

Recherche des organisations par mot-clé et retourne leurs informations détaillées ainsi que les contacts associés.

path Parameters

word

required

string

Responses

Response samples

200
400
404
500

Content type

application/json

{"status": "success",
"message": "result of your research",
"data": [{"organisation_idx": "e71e37b93bbafe8f",
"organisation_raison_sociale": "a orga1",
"organisation_enseigne": "",
"organisation_type": "",
"organisation_email_1": "",
"organisation_email_2": "",
"organisation_mobile_1_prefix": "33",
"organisation_mobile_1": "5 52 43 44 24",
"organisation_mobile_2_prefix": "33",
"organisation_mobile_2": "",
"organisation_telephone_fixe_prefix": "33",
"organisation_telephone_fixe": "",
"organisation_telephone_domicile_prefix": "33",
"organisation_telephone_domicile": "",
"organisation_website": "",
"organisation_address_1": "ddd",
"organisation_address_2": "",
"organisation_zipcode": "",
"organisation_city": "",
"organisation_country": "",
"organisation_note": "",
"organisation_siret": "",
"organisation_created": null,
"organisation_updated": null,
"contacts": [{"contact_idx": "e08fa1ff6617431d",
"contact_firstname": "MATTHIEU",
"contact_lastname": "test",
"contact_gender": "M.",
"contact_fonction": "",
"contact_email_pro": "",
"contact_email_perso": "",
"contact_mobile_1_prefix": "33",
"contact_mobile_1": "",
"contact_mobile_2_prefix": "33",
"contact_mobile_2": "",
"contact_telephone_fixe_prefix": "33",
"contact_telephone_fixe": "",
"contact_telephone_domicile_prefix": "33",
"contact_telephone_domicile": "",
"contact_address_1": "",
"contact_address_2": "",
"contact_city": "",
"contact_country": "",
"contact_zipcode": "",
"contact_note": "",
"organisation_siret": "",
"contact_created": null,
"contact_updated": null
}
]
}
]
}

Rechercher des tags

query Parameters

word

required

string

Le mot-clé à rechercher dans les tags.

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Result of your research",
"data": [{"tag_idx": "string",
"tag_name": "string"
}
]
}

Liste des tags

Retourne une liste de tags associés à l'utilisateur actuel. Le nombre de tags retournés peut être limité par le paramètre limit.

query Parameters

limit

integer

Default: 1000

Nombre maximum de tags à récupérer

Responses

Response samples

200
400

Content type

application/json

[{"tag_idx": "string",
"tag_name": "string",
"contacts": [{"contact_idx": "string",
"contact_gender": "string",
"contact_fonction": "string",
"contact_lastname": "string",
"contact_firstname": "string"
}
],
"contact_count": 0
}
]

Tag par Idx

Retourne les détails d'un tag spécifique et les contacts associés. Le tag doit appartenir à l'utilisateur actuel.

query Parameters

tag_idx

required

string

L'IDx du tag à récupérer

Responses

Response samples

200
400

Content type

application/json

{"tag_idx": "string",
"tag_name": "string",
"contacts": [{"contact_idx": "string",
"contact_firstname": "string",
"contact_lastname": "string",
"contact_gender": "string",
"contact_fonction": "string",
"contact_city": "string",
"contact_country": "string",
"contact_birthday": "string",
"contact_email_pro": "string",
"contact_email_perso": "string",
"contact_mobile_1": "string",
"contact_mobile_1_prefix": "string",
"contact_mobile_2": "string",
"contact_mobile_2_prefix": "string",
"contact_telephone_fixe": "string",
"contact_telephone_fixe_prefix": "string",
"contact_telephone_domicile": "string",
"contact_telephone_domicile_prefix": "string"
}
],
"contact_count": 0
}

Créer un nouveau tag

Crée un nouveau tag associé à l'utilisateur connecté.

Request Body schema: application/json

tag_name

string

Le nom du tag

Responses

Request samples

Payload

Content type

application/json

{"tag_name": "Important"
}

Response samples

200
400

Content type

application/json

{"status": "success",
"message": "Tag created successfully",
"tag_idx": "7cb88539c724896c"
}

Mettre à jour un tag

Met à jour les informations d'un tag existant pour l'utilisateur actuel.

query Parameters

tag_idx required	string L'identifiant unique du tag à mettre à jour
tag_name required	string Le nouveau nom du tag

Responses

Response samples

200
400
403
422

Content type

application/json

{"status": "success",
"message": "Tag updated successfully"
}

Supprimer un tag

Supprime un tag spécifique si celui-ci appartient à l'utilisateur actuel.

query Parameters

tag_idx

required

string

L'identifiant unique du tag à supprimer

Responses

Response samples

200
400
403

Content type

application/json

{"status": "success",
"message": "Tag deleted successfully"
}

Account

Gestionnaire des comptes utilisateurs

User login

Authentification de l'utilisateur

Request Body schema: application/json

email	string
password	string

Responses

Request samples

Payload

Content type

application/json

{"email": "user@example.com",
"password": "password123"
}

Response samples

200

Content type

application/json

{"jwt": "string"
}

User dashboard

Accès au tableau de bord utilisateur

Responses

Response samples

200

Content type

application/json

{"result": "string",
"jwt": "string"
}

File

Gestionnaire des fichiers utilisateurs

Upload a new file

Uploads a file and stores its information in the database.

Request Body schema: multipart/form-data

filename

string <binary>

File to be uploaded

Responses

Response samples

200
400
413
415
500

Content type

application/json

{"status": "success",
"message": "File uploaded successfully",
"data": {"file_idx": "66594aa5b0e96431b299a4d3e2df39d1ec47fdcdad658",
"slug": "image.png",
"url": "https://cdn.ventilo.io/files/66594aa5b0e96431b299a4d3e2df39d1ec47fdcdad658/image.png",
"filename": "Capture d’écran 2024-10-21 à 12.39.03.png",
"date_created": "2024-10-21 17:28:40"
}
}

Retrieve files for the current user

Fetches files associated with the given user ID with optional filtering by file type and pagination.

query Parameters

type	string Example: type=image/ Filter files by MIME type (e.g., 'image/jpeg', or use 'image/' to filter all images)
limit	integer Example: limit=10 Number of files to retrieve per request (default is 10)
offset	integer Example: offset=0 Offset for pagination (default is 0)

Responses

Response samples

200
404

Content type

application/json

[{"file_idx": "6b04d780d771ea17ca85a3ee53ef772a2de4a8813717d",
"filename": "image.png",
"slug": "image",
"url": "https://cdn.ventilo.io/files/6b04d780d771ea17ca85a3ee53ef772a2de4a8813717d/image.png",
"extension": "jpg",
"type": "image/jpeg",
"size": 2555,
"date_created": "2024-10-21 14:03:38"
}
]

Retrieve file by file_idx

path Parameters

file_idx

required

string

Unique identifier of the file

Responses

Response samples

200
404

Content type

application/json

{"file_idx": "6b04d780d771ea17ca85a3ee53ef772a2de4a8813717d",
"filename": "image.png",
"slug": "image-png",
"url": "https://cdn.ventilo.io/files/6b04d780d771ea17ca85a3ee53ef772a2de4a8813717d/image.png",
"extension": "png",
"type": "image/png",
"size": 75278,
"date_created": "2024-10-21 14:11:09"
}

Search files by filename and type

Searches files for the current user based on a provided keyword in the filename and a file type.

query Parameters

word required	string Search keyword to find matching files
type	string Example: type=image Type of file to search for (e.g., image, application)

Responses

Response samples

200
404

Content type

application/json

[{"file_idx": "2234d23fa74803df905b5cc99848014dad32cefe27d8b",
"filename": "Capture d’écran 2024-10-21 à 12.39.03.png",
"slug": "image.png",
"url": "https://cdn.ventilo.io/files/2234d23fa74803df905b5cc99848014dad32cefe27d8b/image.png",
"extension": "png",
"type": "image/png",
"size": 75278,
"date_created": "2024-10-21 14:11:09"
}
]

Delete a file by file_idx

Deletes a file associated with the current user based on its unique identifier (file_idx).

path Parameters

file_idx

required

string

Unique identifier of the file to delete

Responses

Response samples

200
403
404

Content type

application/json

{"status": "success",
"message": "File deleted successfully"
}

Récupère les associations de fichiers par méta et valeur

Cette API permet de récupérer les associations de fichiers en fonction d'un méta et d'une valeur spécifique.

query Parameters

meta required	string Le type de métadonnée à utiliser pour filtrer les associations, par exemple 'formule_idx', 'category', etc.
value required	string La valeur associée au méta pour filtrer les fichiers

Responses

Response samples

200
400

Content type

application/json

{"meta": "formule_idx",
"value": "ce0f731895dae477540f6d717c14d46fe2d2",
"data": [{"file_idx": "8d8cf01a77aa6a762e0832bf2c77a01dde20389a56037",
"filename": "Capture d’écran 2024-10-21 à 22.29.36.png",
"url": "https://cdn.ventilo.io/files/8d8cf01a77aa6a762e0832bf2c77a01dde20389a56037/capture-d-ecran-2024-10-21-a-22-29-36.png",
"date_created": "2024-10-21 20:39:28",
"extension": "png",
"type": "image/png",
"size": 3053930
}
]
}

Supprime une association par file_idx, Meta, Value

Request Body schema: application/json

file_idx required	integer
meta required	string
value required	string

Responses

Request samples

Payload

Content type

application/json

{"file_idx": 1,
"meta": "category",
"value": "documents"
}

Service

Gestionnaire des prestations

Get all formulas

query Parameters

limit

integer

Default: 100

Limit the number of formules returned

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "formule_get_all",
"data": [{"formule_idx": "unique-formule-idx",
"formule_name": "Formule 1",
"formule_duration": "1.5",
"formule_available": true,
"formule_price": "99.99",
"formule_description": "Description of the formule",
"formule_daytime_start": "08:00:00",
"formule_daytime_end": "17:00:00"
}
]
}

Get a single formule

path Parameters

formule_idx

required

string

The unique identifier of the formule

Responses

Response samples

200

Content type

application/json

{"status": "success",
"message": "formule_get",
"data": {"formule_idx": "unique-formule-idx",
"formule_name": "Formule 1",
"formule_duration": "1.5",
"formule_available": true,
"formule_price": "99.99",
"formule_description": "Description of the formule",
"formule_daytime_start": "08:00:00",
"formule_daytime_end": "17:00:00"
}
}

Add a new formula

Request Body schema: application/json

formule_name required	string
formule_duration	decimal
formule_available	boolean
formule_price	decimal
formule_description	string
formule_daytime_start	string <time>
formule_daytime_end	string <time>

Responses

Request samples

Payload

Content type

application/json

{"formule_name": "string",
"formule_duration": null,
"formule_available": true,
"formule_price": null,
"formule_description": "string",
"formule_daytime_start": "14:15:22Z",
"formule_daytime_end": "14:15:22Z"
}

Response samples

200

Content type

application/json

{"status": "success",
"message": "Formule added successfully",
"data": {"formule_idx": "unique-formule-idx",
"formule_name": "Formule 1",
"formule_duration": "1.5",
"formule_available": true,
"formule_price": "99.99",
"formule_description": "Description of the formule",
"formule_daytime_start": "08:00:00",
"formule_daytime_end": "17:00:00"
}
}

Update an existing formula

Request Body schema: application/json

formule_idx required	string
formule_name	string
formule_duration	decimal
formule_available	boolean
formule_price	decimal
formule_description	string
formule_daytime_start	string <time>
formule_daytime_end	string <time>

Responses

Request samples

Payload

Content type

application/json

{"formule_idx": "string",
"formule_name": "string",
"formule_duration": null,
"formule_available": true,
"formule_price": null,
"formule_description": "string",
"formule_daytime_start": "14:15:22Z",
"formule_daytime_end": "14:15:22Z"
}

Response samples

200

Content type

application/json

{"status": "success",
"message": "Formule updated successfully",
"data": {"formule_idx": "unique-formule-idx",
"formule_name": "Formule 1",
"formule_duration": "1.5",
"formule_available": true,
"formule_price": "99.99",
"formule_description": "Description of the formule",
"formule_daytime_start": "08:00:00",
"formule_daytime_end": "17:00:00"
}
}

Delete a formula

path Parameters

formule_idx

required

string

The unique identifier of the formule

Responses

Create a slot for a formula

Request Body schema: application/json

formule_idx required	string
json_slot required	string

Responses

Request samples

Payload

Content type

application/json

{"formule_idx": "string",
"json_slot": "string"
}

Load slots for a formula

path Parameters

formule_idx

required

string

The unique identifier of the formule

Responses

Save excluded days for a formula

Request Body schema: application/json

formule_idx required	string
json_exclude_day required	string

Responses

Request samples

Payload

Content type

application/json

{"formule_idx": "string",
"json_exclude_day": "string"
}

Create options for a formula

Request Body schema: application/json

formule_idx required	string
json_option required	string

Responses

Request samples

Payload

Content type

application/json

{"formule_idx": "string",
"json_option": "string"
}

Get contact information by contact_idx

path Parameters

contact_idx

required

string

The unique identifier of the contact

Responses

Get booking information by booking_idx

path Parameters

booking_idx

required

string

The unique identifier of the booking

Responses

Debug mapping des données des participants

Request Body schema: application/json

participants

required

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"participants": [{ }
]
}

Get contacts associated with an organisation

path Parameters

organisation_idx

required

string

The unique identifier of the organisation

Responses

EmailChecker

Vérifier l'email

Check and validate an email address

This endpoint checks and validates an email address using various filters and tests.

query Parameters

email

required

string <email>

Email address to be validated

Responses

Response samples

200
400
500

Content type

application/json

{"status": "valid",
"result": {"query": "mb@vibrationpixel.com",
"success": 1,
"report": {"validate_email": "Email address is valid.",
"filter_google_dea": "Complete.",
"filter_dea": "Email address is not a DEA (disposable email address).",
"filter_domains": "Email domain is not blacklisted.",
"filter_unsubscribers": "Email address not found in unsubscriber list.",
"check_mx": "Domain passed MX check.",
"smtp_test": "Email passed SMTP simulated send."
}
}
}

Rotore

Créer un Trigger

Cette méthode permet de créer un trigger dans le système.

query Parameters

name required	string Nom du Trigger
description required	string Description du Trigger

Responses

Response samples

200

Content type

application/json

{"trigger_idx": "string"
}

Créer une Condition

Cette méthode permet de créer une condition dans le système.

query Parameters

name required	string Nom de la Condition
description required	string Description de la Condition

Responses

Response samples

200

Content type

application/json

{"condition_idx": "string"
}

Créer une Action

Cette méthode permet de créer une action dans le système.

query Parameters

name required	string Nom de l'Action
description required	string Description de l'Action

Responses

Response samples

200

Content type

application/json

{"action_idx": "string"
}

Créer un Événement

Cette méthode permet de créer un événement dans le système.

query Parameters

name required	string Nom de l'Événement
description required	string Description de l'Événement

Responses

Response samples

200

Content type

application/json

{"event_idx": "string"
}

Créer un Log

Cette méthode permet de créer un log dans le système.

query Parameters

event_idx required	string IDx de l'Événement
status required	string Statut du Log
description required	string Description du Log

Responses

Response samples

200

Content type

application/json

{"log_idx": "string"
}

Lier un Trigger à une Condition

Cette méthode permet de lier un trigger à une condition.

query Parameters

trigger_idx required	string IDx du Trigger
condition_idx required	string IDx de la Condition

Responses

Lier un Trigger à un Log

Cette méthode permet de lier un trigger à un log.

query Parameters

trigger_idx required	string IDx du Trigger
action_idx required	string IDx du Log

Responses

Lier une Condition à une Action

Cette méthode permet de lier une condition à une action.

query Parameters

condition_idx required	string IDx de la Condition
action_idx required	string IDx de l'Action

Responses

Lier une Condition à une Action

Cette méthode permet de lier une condition à une action.

query Parameters

condition_idx required	string IDx de la Condition
log_idx required	string IDx du log

Responses

Lier une Action à un Event

Cette méthode permet de lier une action à un événement.

query Parameters

action_idx required	string IDx de l'Action
event_idx required	string IDx de l'Événement

Responses

Lier une Action à un Log

Cette méthode permet de lier une action à un log.

query Parameters

action_idx required	string IDx de l'Action
log_idx required	string IDx du Log

Responses

Lier un Event à une Condition

Cette méthode permet de lier un événement à une condition.

query Parameters

event_idx required	string IDx de l'Événement
condition_idx required	string IDx de la Condition

Responses

Lier un Event à un Log

Cette méthode permet de lier un événement à un log.

query Parameters

event_idx required	string IDx de l'Événement
log_idx required	string IDx du Log

Responses

Get all details related to a Trigger

path Parameters

trigger_idx

required

string

IDx of the trigger

Responses

Response samples

200
400

Content type

application/json

{"triggers": [{ }
],
"conditions": [{ }
],
"actions": [{ }
],
"logs": [{ }
],
"events": [{ }
]
}

Get all details related to a Condition

path Parameters

condition_idx

required

string

IDx of the condition

Responses

Response samples

200
400

Content type

application/json

{"triggers": [{ }
],
"actions": [{ }
],
"logs": [{ }
],
"events": [{ }
]
}

Get all details related to an Action

path Parameters

action_idx

required

string

IDx of the Action

Responses

Response samples

200
400

Content type

application/json

{"conditions": [{ }
],
"events": [{ }
],
"actions": [{ }
],
"logs": [{ }
]
}

Get all details related to an Event

path Parameters

event_idx

required

string

IDx of the event

Responses

Response samples

200
400

Content type

application/json

{"triggers": [{ }
],
"conditions": [{ }
],
"actions": [{ }
],
"logs": [{ }
]
}

Get all details related to a Log

path Parameters

log_idx

required

string

IDx of the log

Responses

Response samples

200
400

Content type

application/json

{"triggers": [{ }
],
"conditions": [{ }
],
"actions": [{ }
],
"events": [{ }
]
}