FAQ sur l’API

Utilisez POST /api/match pour déterminer si une partie figure sur une liste : il évalue chaque candidat selon le nom, la date de naissance, le pays, le numéro IMO et le type, puis explique la note. Utilisez GET /api/search pour les consultations et les interfaces : il énumère les fiches qui contiennent vos mots, sans note.

Pour qu’ils restent rapides et légers. Récupérez /api/entity/<id> pour obtenir une fiche avec ses inscriptions et les autres registres qui nomment la même partie, ou l’entité fusionnée pour la vue combinée.

Jusqu’à 20 requêtes par demande de correspondance ou de réconciliation, chacune pouvant renvoyer jusqu’à 50 résultats. Les requêtes au-delà de 20 sont ignorées.

Une requête doit comporter au moins un nom ou un numéro IMO. Le champ error indique ce qui manquait, et les autres requêtes du lot sont tout de même exécutées.

L’entrée de chaque registre constitue sa propre fiche; une personne figurant sur cinq listes peut donc produire cinq résultats. Les fiches que nous avons reliées partagent merged_entity.

Les résultats reflètent les fiches chargées au moment de la requête. Certaines réponses en lecture seule (recherche, facettes, sources, programmes, pays) sont mises en cache pendant au plus 10 minutes; les résultats de correspondance ne sont pas mis en cache.

Aucun quota n’est appliqué actuellement. Le service peut appliquer une limite de requêtes par adresse et répond 429 avec Retry-After le cas échéant; voir Limites de requêtes.

• Regroupez jusqu’à 20 parties par demande de correspondance.
• Ne revérifiez pas des parties inchangées par rapport à une collection inchangée : comparez d’abord version de la collection à partir de /api/catalog.
• Ralentissez en cas de 429 et de 503, et réessayez plus tard plutôt qu’immédiatement.
• Pour les grands portefeuilles, envisagez les fichiers en vrac.