Pour les développeurs et les organisations
API pour les développeurs et les organisations
Grâce à l’API gratuite de Ik ben vermist, une commune, une zone de police, un vétérinaire, un refuge ou un site d’information affiche sur son propre site ou son application les animaux perdus ou trouvés dans la région, avec un lien vers le signalement sur ikbenvermist.be. Nous approuvons chaque clé personnellement. Vous recevez uniquement ce qu’il faut pour renvoyer vers nous : l’espèce, la commune, la date et le lien.
- Gratuit
- Sans données personnelles
- Tout renvoie vers ikbenvermist.be
Pourquoi une API ?
Plus un signalement est vu, plus vite l’animal rentre à la maison. Avec l’API, vous placez les signalements de votre région sous forme de liens sur votre propre site : une liste « perdus dans notre commune », un compteur sur votre page d’accueil, une notification dans votre application. Qui clique arrive sur Ik ben vermist, où propriétaires et personnes qui ont trouvé un animal se contactent en toute sécurité. Vous n’affichez ni photos ni descriptions de signalements sur votre site : tout reste ainsi à jour et un signalement disparaît partout dès qu’il est clôturé.
À quoi les organisations utilisent l’API
-
Sites et applis des communes
Un bloc « Perdus et trouvés dans notre commune » avec des liens vers les signalements et vers la page communale sur Ik ben vermist.
-
Police et vétérinaires
Voir dans son propre système ou intranet quels animaux sont perdus dans la zone, et ouvrir le signalement en un clic.
-
Logiciels des refuges
À l’arrivée d’un animal, vérifier s’il existe un signalement dans les environs et ouvrir Ik ben vermist.
-
Sites d’information et médias locaux
Afficher sous forme de liens les signalements actuels d’une commune à côté d’un article sur cette commune.
-
Recherche et politique
Chiffres agrégés et baromètre trimestriel, par province et par espèce, avec mention de la source.
Comment demander une clé
Remplissez le formulaire
Dites-nous qui vous êtes et à quoi servira l’API.
Confirmez votre adresse e-mail
Vous recevez un e-mail avec un lien de confirmation.
Nous approuvons
Un membre de l’équipe examine chaque demande personnellement, généralement en quelques jours ouvrables.
Récupérez votre clé
Vous recevez un lien qui affiche votre clé une seule fois. Conservez-la en lieu sûr.
Envoyer des signalements via l’API
L’envoi de signalements via l’API (par exemple par des vétérinaires ou une autorité publique) est prévu mais pas encore disponible. Même alors, un signalement ne sera jamais publié directement : la personne qui le signale le confirme d’abord par e-mail, puis notre contrôle habituel suit. Intéressé ? Indiquez-le dans votre demande.
Limites et polling
Requêtes par clé
- par minute
- 60
- par heure
- 1 000
- par jour
- 10 000
Ce sont les valeurs par défaut. Besoin de plus ? Demandez-le-nous. info@ikbenvermist.be
Limite atteinte ou forte affluence ?
429- Limite atteinte. Attendez le nombre de secondes indiqué dans
Retry-After. 503- Forte affluence temporaire. Patientez un instant, puis réessayez.
Rester à jour
-
Signalements : au maximum toutes les 15 minutes
Synchronisez avec
updated_sinceetIf-None-Match: sans changement, vous recevez un304sans contenu. -
Chiffres et communes : une fois par jour suffit
-
La même requête vient du cache
Pendant 60 secondes (signalements) ou 1 heure (chiffres, baromètre, communes), vous recevez la réponse précédente.
-
Suppressions dans les 24 heures
Consultez au moins une fois par jour la liste des signalements supprimés et supprimez-les chez vous dans les 24 heures.
Documentation
La documentation décrit chaque endpoint avec ses paramètres et des exemples en curl, JavaScript et PHP, ainsi qu’un explorateur pour essayer l’API immédiatement avec des données d’exemple. Pour vos propres outils, un fichier OpenAPI 3.1 est disponible.
curl -s "https://ikbenvermist.be/wp-json/ibv/api/v1/listings?gemeente=hasselt" \
-H "Authorization: Bearer $IBV_API_KEY"
Conditions d’utilisation
Via notre API, nous ne partageons jamais de données personnelles : pas de noms, de numéros de téléphone, d’adresses e-mail, de numéros de puce, de photos, de descriptions ni d’adresses exactes. Les organisations partenaires reçoivent uniquement l’espèce, la commune, la date et un lien vers le signalement sur Ik ben vermist. Le contact passe toujours par notre site.
Gratuit, après approbation
L’API est gratuite. Chaque clé est approuvée personnellement et valable 12 mois ; vous pouvez la prolonger en un clic.
Toujours un lien vers Ik ben vermist
Affichez pour chaque signalement le lien du champ url, sans le modifier, avec la mention « via Ik ben vermist ». Le contact entre propriétaires, personnes qui ont trouvé l’animal et autres passe toujours par notre site.
Pas de reprise de signalements ni de photos
Vous ne publiez pas de signalements, photos, descriptions ou autres contenus de Ik ben vermist sur vos propres canaux. Vous affichez uniquement les données de l’API, comme renvoi vers notre site.
Pas de vente, pas de croisement avec des données personnelles
Vous ne vendez ni ne louez les données et ne les transmettez pas. Vous ne les combinez pas avec des données personnelles et ne cherchez pas à savoir qui a publié un signalement.
Suppressions dans les 24 heures
Consultez au moins une fois par jour la liste des signalements supprimés et supprimez-les chez vous dans les 24 heures. Il en va de même pour tout ce que vous avez obtenu si votre clé expire ou est révoquée.
Respecter les limites
Respectez les limites et les règles de polling ci-dessus. Utilisez If-None-Match et updated_since plutôt que de tout redemander.
Garder la clé secrète
Votre clé se place uniquement dans l’en-tête Authorization ou X-API-Key depuis votre propre serveur : jamais dans une URL, dans du code exécuté dans le navigateur ou dans un dépôt public. Vous soupçonnez une fuite ? Signalez-le immédiatement, nous en créerons une nouvelle.
Nous pouvons révoquer
Nous pouvons mettre en pause ou révoquer une clé à tout moment, par exemple en cas d’abus, si les conditions ne sont pas respectées ou si vous ne l’utilisez pas pendant 90 jours. Nous pouvons modifier l’API ; nous annonçons les changements importants à l’avance.
Pas de garantie
Nous faisons de notre mieux pour que l’API reste disponible et correcte, mais ne garantissons ni sa disponibilité ni son exhaustivité.
Contact
Des questions, besoin d’une limite plus élevée ou un problème à signaler ? Écrivez à info@ikbenvermist.be.
Questions fréquentes
Combien coûte l’API ?
Rien. L’API est gratuite pour les organisations, les développeurs, les médias et les chercheurs. Chaque clé est toutefois approuvée personnellement.
Quelles données vais-je recevoir ?
Pour chaque signalement : le numéro, le statut (perdu, trouvé, aperçu ou de retour à la maison), l’espèce, la commune et la province, la date et un lien permanent vers le signalement sur ikbenvermist.be. En plus, des chiffres, le baromètre et la liste des communes. Jamais de données personnelles, de photos ni de descriptions.
Pourquoi pas de photos ni de descriptions ?
Parce qu’elles appartiennent aux propriétaires et aux personnes qui ont trouvé l’animal, et qu’elles peuvent vite changer ou disparaître. En renvoyant toujours vers notre site, chacun voit le signalement à jour, et celui-ci disparaît partout dès qu’il est clôturé. Le contact passe par notre formulaire sécurisé, si bien que personne ne doit partager son adresse e-mail.
Les propriétaires peuvent-ils choisir si leur signalement est partagé ?
Oui. En publiant un signalement, on peut cocher qu’il ne soit pas partagé via l’API, et changer d’avis plus tard. Ce signalement n’apparaît alors pas dans l’API et figure dans la liste des signalements supprimés.
En combien de temps reçoit-on une clé ?
Généralement en quelques jours ouvrables. Après approbation, vous recevez un lien qui affiche votre clé une seule fois.
Puis-je utiliser l’API dans le navigateur ?
Non, la clé doit rester sur votre propre serveur. Votre serveur récupère les données et votre site affiche les liens. Votre clé reste ainsi secrète.
Puis-je aussi envoyer des signalements ?
Pas encore. Cette possibilité est prévue, par exemple pour les vétérinaires ou une autorité publique. Faites-nous savoir si cela vous intéresse.