API REST de Spedmo

Vous cherchez à utiliser certaines fonctionnalités de Spedmo dans votre propre application? Alors vous êtes au bon endroit.

L'API REST de Spedmo permet aux applications externes et aux sites Web de s'intégrer aux données et aux services de Spedmo. L'API est libre d'utilisation et une définition complète des services fournis peut être trouvée dans notre interface de spécification de l'API Swagger UI qui fournit également un harnais de test utile pour tester et dépanner les fonctionnalités de l'API.

Commencer

1. Obtenez une clé API (SPEDMO-API-KEY)

Avant d'utiliser l'API pour votre application, vous devez générer une clé API qui fournira le mécanisme permettant d'identifier vos appels à l'API à partir d'autres applications. Pour commencer, connectez-vous simplement à Spedmo avec votre compte et votre clé API peut être générée à partir de la console API Management .

Votre clé API sera un UUID et s'appelle " SPEDMO-API-KEY " lorsqu'elle est utilisée pour les transactions avec le service.

2. Testez que la clé est fonctionnelle avec l'API

L' interface de spécification de l'API Spidmo REST Swagger UI permet un test web rapide et facile de l'API sans avoir besoin de configurer un logiciel personnalisé et peut être utilisé comme un outil de débogage rapide et facile pour tout problème d'intégration pouvant survenir avec votre application .

Avec votre clé API, vous devriez pouvoir tester News.api et vérifier que votre clé vous permet d'obtenir une réponse du système. Entrez simplement votre clé dans le harnais et cliquez sur le bouton " Essayez-le! ". Si votre test a réussi avec le contenu renvoyé, vous êtes prêt à intégrer des fonctionnalités dans votre application.

Alternativement, l'API peut être atteinte en utilisant une application telle que CURL comme indiqué dans l'exemple ci-dessous.

curl -X GET --header 'Accepter: application / json' --header 'SPEDMO-API-KEY: VOTRE-CLÉ-ICI ' 'https://www.spedmo.com/api/v1.0/news.api '

Si votre clé ne renvoie pas de résultat, vérifiez que vous avez correctement suivi les instructions ci-dessus.

3. Obtenir une clé utilisateur pour obtenir des données personnelles (SPEDMO-ACCESS-KEY)

Pour les principales fonctionnalités de l'API REST, une clé d'utilisateur sera nécessaire pour lire les données personnelles telles que les coordonnées de l'utilisateur et les contributions des utilisateurs (vols, livraisons, etc.). Cette clé est obtenue en demandant à un utilisateur d'accéder à votre application, la clé obtenue est valide indéfiniment, il n'est donc pas nécessaire de re-demander cette clé à un utilisateur une fois que votre application l'a reçu. application ou service.

Pour présenter l'utilisateur à la demande, il vous suffit d'afficher / encadrer l'URL suivante dans votre application https://www.spedmo.com/apiAuthorise.pg et de présenter votre " SPEDMO-API-KEY " dans l'en-tête de la requête. Si vous souhaitez supprimer la navigation Spedmo de l'expérience, ajoutez simplement ' whitelabel = true ' en tant que paramètre de requête.

curl -X GET --header 'Accepter: application / json' --header 'SPEDMO-API-KEY: VOTRE-CLÉ-ICI ' 'https://www.spedmo.com/apiAuthorise.pg?whitelabel=true'

La réponse retournera en HTML et devrait être présentée directement pour utiliser l'utilisateur, un exemple de sortie attendue est montré dans le diagramme ci-dessous.

Spedmo s'occupera du traitement des entrées des utilisateurs, votre application devrait surveiller l'en-tête de la réponse de la page et rechercher la " CLE DE L'ACCÈS À LA SPEDMO ". Cette clé associée à votre " SPEDMO-API-KEY " permettra à votre application d'utiliser toutes les fonctionnalités de l'API REST de Spedmo.

4. Testez qu'une clé utilisateur est fonctionnelle avec l'API

Avec votre clé d'utilisateur, obtenez des informations sur les membres de l'utilisateur à l'aide de Member.api .

curl -X GET --header 'Accepter: application / json' --header 'SPEDMO-ACCESS-KEY: USER-CLÉ-ICI ' --header 'SPEDMO-API-KEY: VOTRE-CLÉ-ICI ' 'https: / /www.spedmo.com/api/v1.0/member.api '

Pour la documentation sur toutes les autres fonctionnalités de l'API REST, veuillez consulter la spécification de l'API Swagger UI .