L'API Alma est une API REST qui accepte et retourne des données au format JSON. Vous pouvez utiliser des requêtes HTTP pour communiquer avec l'API mais nous proposons également un clients PHP que nous vous conseillons d'utiliser.

Si vous utilisez une plateforme e-commerce, intégrez Alma avec l'un de nos modules.

Compte Alma et sandbox

Vous pouvez créer votre compte Alma en 1 minute ici.

Nous mettons également à votre disposition un environnement de test (la "sandbox") qui vous permet de tester votre intégration de bout en bout avant de passer en production.

Votre dashboard principal vous donne accès à vos clefs d'API de production et de test, mais si vous souhaitez consulter vos données de test ou paramétrer votre compte de test, vous devez vous rendre sur le dashboard sandbox : https://dashboard.sandbox.getalma.eu.

Votre compte sandbox est créé automatiquement avec les mêmes identifiant et mot de passe que votre compte principal, mais les données et configurations sont ensuite totalement indépendantes et non synchronisées entre les deux comptes.

La clé live peut être utilisée avec le mode "live" des clients d'API, ou bien en ciblant le domaine principal de notre API si vous n'utilisez pas l'un de nos clients d'API : https://api.getalma.eu.
La clé de test peut être utilisée avec le mode "test" des clients d'API, ou bien en ciblant le domaine de sandbox si vous n'utilisez pas l'un de nos clients d'API : https://api.sandbox.getalma.eu.

Une fois votre intégration testée et votre compte de production activé, vous pouvez passer live : il vous suffit de cibler le domaine de production de l'API (ou de changer du mode "test" au mode "live" avec nos clients d'API), et de remplacer la clé d'API de test par celle de production.

Si l'authentification d'un appel échoue, l'API renverra une erreur 401 incluant les raisons de l'échec.

URLs de base de l'API

Chaque environnement utilise une URL de base dédiée :

Environnement	URL
Production	`https://api.getalma.eu/v1/`
Sandbox	`https://api.sandbox.getalma.eu/v1/`