Documentation de l'API

Cette page est destinée aux développeurs et développeuses désirant intégrer les données de Mixtures.info dans une application tierce. Notre base de données contient 35 substances liées par 190 interactions, disponibles au format JSON par le biais d'un service HTTP.

balance Conditions d'utilisation

Licence

Toutes nos données sont distribuées sous licence Creative Commons CC-BY-SA 4.0. Tout travail utilisant cette API doit se conformer aux termes de cette licence, incluant l'obligation de créditer la provenance des données et de partager tout travail dérivé sous la même licence.

Bonnes pratiques

Utilisez cette API de manière responsable. Cela inclue modérer la fréquence de vos requêtes, et envoyer aussi peu de requêtes que possible pour effectuer une action donnée.

Mettre les données nécessaires en cache localement est une bonne chose. Au lieu d'effectuer un grand nombre de requêtes de recherche, nous fournissons un endpoint aliases dont vous pouvez mettre la réponse en cache, pour ensuite effectuer vos recherches localement.

Nous nous réservons le droit de suspendre l'accès à l'API en cas de mauvaise utilisation.

translate Internationalisation

Tous les endpoints de l'API supportent l'internationalisation. Le language de réponse désiré peut être spécifié en préfixant les URIs de l'API par un code de langue (par exemple /fr/api/v1/... pour le français). Si aucun préfixe de langue n'est spécifié (/api/v1/...), le système essaiera d'en choisir un en accord avec les en-têtes de votre requête, et effectuera une redirection.

Codes de langue disponibles : fr, en.

link Endpoints

GET http://mixtures.info/api/v1/aliases/
Schemas description

A list of all avalaible aliases, mapping them to substance slugs and URLs.

This is useful for caching or if you want to implement your own search logic locally.

GET http://mixtures.info/api/v1/search/:name/
Schemas description
Parameter Converter
name StringConverter

Get a substance by name and return its slug and URL.

Database slugs, names and aliases will be matched against the query.

GET http://mixtures.info/api/v1/substances/
Schemas description

List all substances in the database, and get a basic summary of them.

GET http://mixtures.info/api/v1/substance/:slug/
Schemas description
Parameter Converter
slug SlugConverter

Get some detailled information about a substance and a basic summary of its interactions.

The slug parameter has to be exact, use the search endpoint to get a substance slug from its name or aliases.

GET http://mixtures.info/api/v1/combo/:slugs/
Schemas description
Parameter Converter
slugs SlugListConverter

Get detailled information about a substance combination.

The slugs parameter must be a list of valid slugs sepatared by plus characters (eg. .../combo/drug-a+drug-b/). A maximum of 5 substances is allowed in each query.