Utiliser l’API Shielk
Créez une clé API Shielk, masquez les renseignements des personnes dans un texte en un seul appel et remplacez la clé au besoin.
Lire la vidéo en texte
Démarrage rapide de l’API Shielk, dans Shielk.
La clinique de cette vidéo est fictive, comme chaque détail.
Votre clé API est à la page Compte. Seul un court aperçu s’affiche; la clé complète ne s’affiche qu’une fois, à sa création.
Envoyez la clé dans l’en-tête X API Key de chaque requête.
Le portail développeur montre une première requête, la réponse obtenue, les codes d’erreur et les limites de débit.
Besoin d’une nouvelle clé ? Régénérez-la depuis le portail, puis mettez-la à jour partout où vous l’utilisez.
À quoi ça sert
Votre propre application ou script peut envoyer du texte à Shielk et le recevoir avec les renseignements des personnes masqués. Il vous faut une clé API. Cette page montre comment créer la clé, faire votre premier appel et remplacer la clé.
Ceci est une orientation générale, pas un avis juridique.
Avant de commencer
- Forfait : Pro, Agence ou Entreprise. Pro a 10 000 appels API par mois, Agence 50 000 et Entreprise 250 000. Gratuit n’a pas de clé API.
- Rôle : vous, connecté à l’application Web Shielk. Une clé ne peut pas créer une autre clé.
- À avoir sous la main : un terminal ou un outil qui envoie des requêtes Web.
Étapes
Cliquez sur Générer une clé API
Ouvrez votre page Compte. Dans la carte Accès API, cliquez sur Générer une clé API.
Vous verrez la clé complète une seule fois, avec Copiez cette clé maintenant. Elle n’est affichée qu’une seule fois. Cliquez sur Copier et gardez la clé en lieu sûr.

Faites votre premier appel
Envoyez le texte au point d’accès anonymize. Mettez votre clé dans l’en-tête X-API-Key. La clé ci-dessous est un faux exemple.
curl -X POST https://app.shielk.com/api/v1/anonymize \
-H "Content-Type: application/json" \
-H "X-API-Key: csk_VOTRE_CLE_ICI" \
-d '{"text": "Alex Exemple, NAS 046-454-286", "language": "fr"}'Seul text est obligatoire. language peut valoir auto, en ou fr. Vous pouvez aussi envoyer jurisdiction, un code de province comme QC, et industry.
Lisez la réponse
La réponse est en JSON. anonymized_text est votre texte avec des codes. reverse_mapping donne chaque code avec sa vraie valeur, pour que votre application remette les valeurs. usage montre vos appels du mois.
{
"status": "success",
"data": {
"anonymized_text": "<PERSON_1>, NAS <CA_SIN_1>",
"entity_count": 2,
"entities_found": [
{ "entity_type": "PERSON", "start": 0, "end": 12, "token": "<PERSON_1>" },
{ "entity_type": "CA_SIN", "start": 18, "end": 29, "token": "<CA_SIN_1>" }
],
"detected_language": "fr",
"reverse_mapping": { "<PERSON_1>": "Alex Exemple", "<CA_SIN_1>": "046-454-286" }
},
"usage": { "jobs_used": 1, "jobs_limit": 10000, "jobs_remaining": 9999, "tier": "pro" },
"disclaimer": "This analysis is generated by automated detection and is provided for informational purposes only."
}Cet exemple est abrégé et tiré des champs que le code renvoie. La vraie réponse contient plus de champs, et ses valeurs dépendent de votre texte.
Remplacez la clé
Dans la page Compte, cliquez sur Créer une nouvelle clé. Vous verrez Votre clé actuelle cesse de fonctionner immédiatement. Confirmez. Copiez la nouvelle clé et mettez-la dans votre application.
Aucun bouton ne désactive la clé API sans en créer une nouvelle. Pour arrêter la clé actuelle, créez-en une nouvelle. L’ancienne cesse de fonctionner immédiatement.
Ce que vous verrez
Après avoir quitté la page, la carte Accès API affiche Aperçu seulement. La clé complète s’affiche une seule fois, à sa création. et un court aperçu de la clé. Vous ne pouvez plus copier la clé complète.
Le Portail développeur montre votre Limite mensuelle, le Nom de la clé et comment l’Utiliser dans l’en-tête.

Votre clé API est distincte de votre clé d’extension de navigateur. Pour l’extension, utilisez la carte Clé de l’extension de navigateur.
Erreurs fréquentes et solutions
Vous voyez L'accès API nécessite le forfait Pro ou supérieur. Vous êtes au forfait Gratuit. Passez à un forfait supérieur pour obtenir une clé.
Vous avez perdu la clé. Vous ne pouvez plus la voir. Cliquez sur Créer une nouvelle clé, puis mettez votre application à jour.
Vous avez utilisé votre clé d’extension dans votre application. Elle fonctionne seulement avec l’extension. Créez une clé API.
Le texte est long. Envoyez jusqu’à 50 000 caractères par appel.
Si ça n’a pas fonctionné
Les messages de l’API s’affichent en anglais, sauf celui de la clé d’extension.
Invalid API key. Check your X-API-Key header. La clé est fausse ou a été remplacée. Copiez la clé actuelle.
No text provided. Envoyez un champ text qui n’est pas vide.
The request body must be a JSON object, for example {"text": "your text here"}. Envoyez un seul objet JSON, pas une liste ni une chaîne.
Text too long. Maximum 50,000 characters : le texte dépasse la limite. Divisez-le.
API key monthly limit reached : vous avez utilisé les appels du mois. Passez à un forfait supérieur ou attendez le mois prochain.
API keys require a Pro subscription or higher. Upgrade at shielk.com/pricing : votre compte est au forfait Gratuit.
Cette clé fonctionne seulement avec l’extension de navigateur Shielk. Vous avez envoyé la clé d’extension. Utilisez la clé API.
Impossible de générer la clé API. Cliquez de nouveau sur Générer une clé API.