Liste des Documents
Sur Cette Page

Appels API

Réaliser des appels API vers ProcessMind

Ce guide propose exemples et bonnes pratiques pour utiliser l’API ProcessMind. Que vous vouliez récupérer des données, soumettre des infos ou automatiser vos process, maîtriser notre API est essentiel.

Variables d’authentification

  • apiKey Pour toutes les requêtes API, ajoutez la clé API dans les en-têtes pour l’authentification. Vous pouvez obtenir la clé API dans les paramètres de votre compte ProcessMind.
  • tenantId Certains endpoints API nécessitent un Tenant ID pour préciser le contexte de la requête. Cet identifiant unique à votre organisation est aussi accessible dans les paramètres du compte.
  • datatableId Pour travailler avec un dataset, indiquez le Datatable ID pour identifier la datatable cible. Cet identifiant se trouve dans le menu des paramètres du dataset [Get Data Table ID] dans ProcessMind.

Upload direct de fichiers

ProcessMind permet de téléverser des fichiers directement vers vos datatables grâce à des URL presignées. Cette méthode sécurise les uploads sans exposer votre clé API ou d’autres données sensibles. Notez que les URL presignées sont limitées dans le temps : il faut les utiliser rapidement après leur génération. Pour obtenir l’URL d’upload direct, faites une requête GET à l’endpoint dédié. L’URL se récupère via le menu des paramètres du dataset [Get upload URL] sur ProcessMind. Vous pouvez définir une durée limite de 1 heure, 1 semaine ou 1 mois maximum.

Vue d’ensemble des endpoints

MéthodeEndpointDescription
GET/tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurlRetourne une URL temporaire pré-signée pour téléverser un fichier sur une datatable.
GET/tenant/{tenantId}/datasetsListe les datasets du tenant indiqué.
GET/tenant/{tenantId}Affiche les détails du tenant spécifié.
GET/tenant/{tenantId}/organizationAffiche les infos sur l’organisation du tenant.

URL de base

Toutes les requêtes API doivent être envoyées à l’URL de base suivante : https://api.processmind.com

Obtenir une URL de téléversement pré-signée

Endpoint : GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl Paramètres :

  • tenantId – ID du tenant (string).
  • datatableId – ID de la datatable cible (string).
  • apiKey – Votre clé API (string).

Renvoie : Un objet réponse contenant PreSignedUploadUrl, une URL temporaire à utiliser pour téléverser un fichier (généralement via HTTP PUT).

Exemple (avec le helper) :

const presignedUrl = await getPresignedUploadUrl({
  apiKey,
  tenantId: 'tenant-123',
  datatableId: 'table-456'
});
console.log(presignedUrl); // ex : https://s3.amazonaws.com/…?X-Amz-Signature=…

Lister les datasets

Endpoint : GET /tenant/{tenantId}/datasets Paramètres :

  • tenantId – ID du tenant.
  • apiKey – Votre clé API.

Renvoie : Un tableau d’objets dataset appartenant au tenant.

Exemple :

const datasets = await getDatasets({
  apiKey,
  tenantId: 'tenant-123'
});
console.log(datasets);

Récupérer les informations du tenant

Endpoint : GET /tenant/{tenantId} Paramètres :

  • tenantId – ID du tenant.
  • apiKey – Votre clé API.

Renvoie : Un objet avec les métadonnées du tenant : nom, date de création et plan.

Exemple :

const tenantInfo = await getTenant({
  apiKey,
  tenantId: 'tenant-123'
});
console.log(tenantInfo);

Obtenir les informations de l’organisation

Endpoint : GET /tenant/{tenantId}/organization Paramètres :

  • tenantId – ID du tenant.
  • apiKey – Votre clé API.

Renvoie : Les informations sur l’organisation associée au tenant (ex : nom d’entreprise, adresse, contacts).

Exemple :

const org = await getOrganization({
  apiKey,
  tenantId: 'tenant-123'
});
console.log(org);

Téléverser un fichier

La fonction uploadFile montre comment téléverser un fichier via une URL pré-signée. Le workflow est :

  1. Obtenir l’URL pré-signée avec getPresignedUploadUrl.
  2. Faire une requête PUT vers cette URL avec le fichier. L’URL autorise l’upload direct vers le storage provider, sans autres identifiants.
  3. (Facultatif) Prévenez votre API quand l’upload est terminé, selon votre backend.

Exemple simplifié avec fetch :

async function uploadFile({ apiKey, tenantId, datatableId, file }) {
  // Étape 1 : obtenir une URL pré-signée
  const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
  
  // Étape 2 : upload du fichier via PUT
  await fetch(uploadUrl, {
    method: 'PUT',
    headers: {
      'Content-Type': file.type
    },
    body: file
  });
  
  // Étape 3 : prévenir votre API si besoin
  // (dépend de votre backend)
}

info

  • Les URLs pré-signées expirent vite (en général quelques minutes). Utilisez-les dès réception.
  • Si un upload échoue (ex : coupure réseau), obtenez une nouvelle URL pré-signée avant de réessayer.
  • Gardez toujours votre apiKey sécurisée et ne l’exposez jamais côté client (par ex. en front-end public).

Exemple BASH

Script Bash minimal pour uploader un fichier sur ProcessMind via deux appels curl et variables personnalisables

Télécharger l’exemple BASH

Exemple NodeJS

Upload d’un fichier CSV local vers ProcessMind via une URL présignée.

Étapes :

  1. Récupérez une URL d’upload présignée depuis l’API.
  2. Lisez le fichier local depuis le disque.
  3. Envoyez le fichier en HTTP PUT sur l’URL présignée.

Configuration :

  • Indiquez votre API key, tenantId, datatableId et filePath lors de l’appel à uploadFileToProcessMind().
  • L’URL de base de l’API est https://api.processmind.com
Télécharger l’exemple NodeJS

Exemple Python

Upload d’un fichier CSV local vers une API distante avec une URL présignée.

Étapes :

  1. Récupérez l’URL présignée depuis l’API.
  2. Lisez le fichier local.
  3. Uploadez le fichier sur l’URL en HTTP PUT.

Configuration :

  • Mettez à jour api_key, tenant_id, datatable_id, file_path selon vos besoins.
Télécharger l’exemple Python