API – Changements

API – Changements

Pour tous ceux utilisant l’API publique, il y aura d’importantes modifications début 2018. Toutes les infos sont sur le blog.

Voici dans ses grandes lignes les modifications qui entreront en vigueur début 2018. Toutes les applications utilisant notre API devront :

  • être effectuées par l’HTTPS
  • utiliser les domaines officiels api.spreadshirt.com (plateforme américaine) et api.spreadshirt.net (plateforme européenne)
  • envoyer une clé API valide
  • mettre à disposition un agent utilisateur

HTTPS

Deux précautions valent mieux qu’une. Toutes les requêtes avec notre API seront effectuées via l’HTTPS. Les interactions effectuées via HTTP seront prochainement redirigées vers l’HTTPS.

Domaines officiels

Toutes les requêtes devront être effectuées via nos domaines officiels api.spreadshirt.com et api.spreadshirt.net. Les autres chemins pour utiliser l’API ne seront plus accessibles. Pour des raisons de sécurité, nous nous réservons le droit de bloquer les chemins d’accès non officiels.

Clé API

Toutes les applications présentant des requêtes à notre API doivent joindre une clé API valide. Le plus simple est d’ajouter à chaque URL un paramètre de requête avec une  clé API comme :

https://api.spreadshirt.net/api/v1/shops/205909?apiKey=8e5bb312-9060-446f-ada2-8c319327745a

Même si nous accepterons encore cette méthode, nous vous recommandons plutôt d’utiliser le header d’autorisation prévu (https://developer.spreadshirt.net/display/API/Security) comme :

  • https://api.spreadshirt.net/api/v1/shops/205909
  • Authorization: SprdAuth apiKey=”8e5bb312-9060-446f-ada2-8c319327745a”

Le header est également crypté pour communiquer avec l’HTTPS.

Les clés API de la plateforme américaine et européenne :

  • https://www.spreadshirt.de/-C7120
  • https://www.spreadshirt.com/-C6840

Agent utilisateur

Toutes les applications ne passant pas un moteur de recherche devront à l’avenir joindre un agent utilisateur (user agent) valide. Il permet d’identifier l’utilisateur de l’API. L’agent utilisateur a cette forme :

Agent utilisateur : <VotreApplication>/< LaVersionDeVotreApplication> (https://www.votredomain.com; votrenom@votredomaine.com)

Voici un exemple :

Agent utilisateur : WordPress-Plugin/1.0 (https://www.votreblog.com; admin@votreblog.com)

Si vous utilisez notre API, veuillez ajouter à côté du nom de l’application et de la version, le domaine et l’adresse e-mail de l’administrateur. Cela nous permettra de vous contacter en cas d’urgence.

Nous espérons que vous apprécierez ces changements autant que nous. Si vous avez des questions, n’hésitez pas !

  • Non classé

6 commentaires Écrire un commentaire