Premiers pas avec l’API

Une seule API JSON en lecture seule assure la correspondance, la consultation d’entités et la recherche sur toutes les fiches que nous publions. Cette page explique le rôle de chaque composante et les prochaines étapes.

AuthentificationComment fonctionne l’accès aujourd’hui et ce qu’ajoute une licence de production.L’API de correspondanceVérifiez des personnes, des sociétés et des navires par rapport à une collection.L’API d’entitésObtenez une fiche avec ses inscriptions et les fiches connexes.L’API de rechercheRecherche par mot-clé et filtres pour les interfaces et la recherche.

Ce que fait l’API

Le service de données de Crown Intelligence est une API JSON en lecture seule portant sur les mêmes fiches que celles affichées sur ce site. Trois points d’accès font l’essentiel du travail :

POST /api/match/<collection> compare ce que vous savez d’une partie (noms, date de naissance, nationalité, numéro IMO, type d’entité) à chaque fiche candidate d’une collection et renvoie des résultats notés et expliqués. Utilisez-le pour la vérification.
GET /api/entity/<id> renvoie une fiche avec ses inscriptions et les autres registres qui désignent la même partie, ou une entité fusionnée constituée à partir de l’ensemble de ceux-ci.
GET /api/search/<collection>?q= trouve des fiches par nom, avec des filtres. Utilisez-le pour la consultation et les interfaces, et non pour les décisions de vérification : les résultats de recherche ne sont pas notés.

Des points d’accès complémentaires énumèrent les collections (/api/catalog), les méthodes de notation (/api/algorithms), les sources, les programmes, les pays et les facettes. La référence des points d’accès les présente tous.

Obtenir l’accès

Aucune clé API n’est requise actuellement. Les points d’accès publics répondent aux requêtes anonymes. L’utilisation dans un processus d’affaires, la vérification systématique et la redistribution sont couvertes par une licence commerciale; consultez Authentification pour plus de détails.

À venir : Modalités d’émission des clés API, de l’accès d’essai et des clés destinées aux utilisateurs d’intérêt public ou sans but commercial (décision du propriétaire; aucun système de clés n’existe encore).

Envoyer votre première requête

Suivez le démarrage rapide pour envoyer une requête de correspondance et lire le résultat.
Lisez Authentification pour comprendre le fonctionnement de l’accès et des limites.
Chargez la description OpenAPI 3 dans votre client API ou votre générateur de code.
Essayez le même moteur de correspondance de façon interactive dans Vérification; la page affiche la commande cURL de chaque contrôle.

À venir : Publierons-nous une bibliothèque cliente, un outil en ligne de commande ou un serveur MCP pour l’API (décision du propriétaire).

Les points d’accès

L’API de correspondanceVérification par lots avec notes et explications. Approfondissements : la requête et la réponse.
L’API d’entitésUne fiche avec ses inscriptions imbriquées, ou une entité fusionnée entre registres.
L’API de rechercheRecherche par nom avec filtres et facettes; non destinée aux décisions de vérification.
Référence des points d’accèsChaque route, paramètre et champ, avec des exemples de code.

Comprendre les résultats

Référence du modèle : types d’entités et propriétés que nous publions.
Sujets de risque : les étiquettes topics de chaque résultat.
Programmes de sanctions : le programme de chaque inscription.
Entités à plat et imbriquées : comment s’articulent les fiches, les inscriptions et les entités fusionnées.

Mettre en place un processus de vérification

Ajuster le moteur de correspondance : seuil, méthode de notation, filtres et données d’entrée.
Algorithmes de correspondance : caractéristiques, effets et constantes de chaque méthode de notation.
Mettre en place un flux de surveillance : revérifiez à mesure que les listes changent.
Déploiement sur site : effectuez la vérification dans votre propre réseau à partir d’une copie locale des données.

Ce que l’API prend en charge aujourd’hui

Une liste claire de ce qui est offert et de ce qui ne l’est pas, pour vous aider à planifier.

Fonctionnalité	Offerte	Remarques
Correspondance par lots	Oui	Jusqu’à 20 requêtes par envoi, jusqu’à 50 résultats chacune.
Seuil de score	Oui	`?threshold=`, de 0 à 1; 0,75 par défaut.
Choix de la méthode de notation	Oui	`?algorithm=standard` ou `name-only`; énumérées par `/api/algorithms`.
Filtres par sujet et par registre	Oui	`topics`, `include_dataset`, `exclude_dataset` pour la correspondance et la recherche.
Entités fusionnées	Oui	`/api/entity/<entity_id>` regroupe toutes les fiches d’une même partie.
Rapprochement OpenRefine	Oui	`/api/reconcile/<collection>`, API de rapprochement 0.2.
Catalogue des collections	Oui	`/api/catalog`, d’après l’index de la version courante.
Description OpenAPI	Oui	openapi.json.
Clés API et rapports d’utilisation	Pas encore	Voir Authentification.
Pondérations personnalisées des caractéristiques	Pas encore	Chaque méthode de notation a des effets fixes; voir Algorithmes de correspondance.
Correspondance d’identifiants au-delà des numéros IMO	Pas encore	Les numéros d’enregistrement, les numéros fiscaux et les LEI ne sont pas encore notés.
Filtre des changements depuis une date pour la correspondance	Oui	`?changed_since=` pour la correspondance et la recherche; voir Surveillance.
Point d’accès de traçabilité au niveau des déclarations	Pas encore	Utilisez `statements.csv` dans les fichiers en vrac.
Pagination des fiches connexes	Pas encore	Les fiches connexes sont limitées à 100 par fiche.

Aspects commerciaux

L’API fait partie de notre offre commerciale. Consultez la tarification, la FAQ commerciale ou communiquez avec l’équipe des ventes.

À venir : Mode de mesure et de tarification de l’utilisation de l’API (par requête, par envoi ou forfaitaire), rabais de volume, et présence éventuelle d’un portail client pour consulter l’utilisation et la facturation. Les frais indiqués dans le résumé de licence ne sont que des propositions.

Dernière mise à jour : 2026-10-03