L’API HTTPS

Tout ce que font les bibliothèques passe par cette API : du JSON sur HTTPS, utilisable depuis n'importe quel langage. Les méthodes de MongoDB y ont chacune leur adresse (…/collections/patients:find), avec les mêmes arguments que dans le pilote.

L'adresse

https://votre-ished.example/v1/… parle au premier cluster du projet ; https://votre-ished.example/v1/clusters/<nom>/… à un cluster nommé. L'adresse exacte est dans la console (Vue d'ensemble › « Obtenir l'adresse de connexion »). GET /v1/health répond { "ok": true } sans clé : il dit seulement que le service répond.

L'authentification

Chaque requête porte une clé du projet :

curl -H "Authorization: Bearer $ISHED_KEY" "$ISHED_URL/v1/bases"

La clé n'est acceptée que depuis une adresse IP autorisée du projet, et seulement en HTTPS. Son rôle borne ce qu'elle peut faire : lecture, écriture (lire et écrire), administration (en plus : définitions, import, journal). Une clé limitée à certaines bases ou collections ne voit que celles-là.

Les requêtes et les réponses

Les corps sont en JSON (Content-Type: application/json), 2 Mo au plus (16 Mo pour un import). Trois types que JSON n'a pas s'écrivent ainsi, dans les deux sens :

const ajout = await fetch(`${process.env.ISHED_URL}/v1/bases/Clinique/collections/visites:insertOne`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.ISHED_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ document: { patient: 'awa', le: { '~date': '2026-11-12T08:00:00.000Z' } } }),
});
console.log(ajout.status, await ajout.json()); // 201 { acknowledged: true, insertedId: '…' }

const trouves = await fetch(`${process.env.ISHED_URL}/v1/bases/Clinique/collections/visites:find`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.ISHED_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ filter: { patient: 'awa' }, sort: { le: -1 }, limit: 10 }),
});
const { documents } = await trouves.json();
console.log(documents[0].le); // { '~date': '2026-11-12T08:00:00.000Z' }

Les lectures rendent 1000 documents au plus par réponse ; la suite se demande avec le nextPageToken reçu.

Avec Postman

Toute l'API est dans une collection Postman, avec son environnement : une requête par adresse, dans un ordre qui se joue du début à la fin. Importez les deux fichiers (Import, puis déposez-les), choisissez l'environnement « IshedDB », mettez l'adresse de votre cluster dans baseUrl et votre clé dans ishedKey (une variable secrète). Jouée en entier avec le Runner, la collection crée la collection rendezvous_postman dans la base Essais et la supprime à la fin ; il lui faut une clé d'administration. Nos tests la jouent en entier contre un vrai serveur IshedDB à chaque version.

La collection ne contient aucune clé. Utilisez l'application de bureau de Postman : avec son agent dans le nuage, vos requêtes et votre clé passent par les serveurs de Postman, depuis une adresse IP qui n'est pas la vôtre.

Les erreurs

Un refus répond un statut HTTP et { "error": { "code", "message", "requestId" } } (et parfois details, par exemple les champs refusés). Donnez le requestId à l'assistance : il retrouve la requête dans nos journaux.

Les adresses

Les arguments des méthodes de MongoDB sont ceux de son pilote : filter, update, sort, projection, limit, skip, pipeline, upsert, ordered… La bibliothèque Node.js donne la liste des opérateurs.