Introduction

URL de base de l'API

Si vous hébergez Stend sur votre propre serveur, vous devrez utiliser l'URL de base de votre instance pour faire vos requêtes. Par exemple, si vous hébergez Stend sur https://stend-api.example.com, la requête vers /instance sera à l'URL https://stend-api.example.com/instance.

Version

L'API de Stend n'est pas versionnée. Une requête vers /instance indique la version utilisée par l'instance de Stend utilisée. Des changements peuvent être apportés à l'API dans le futur, soyez vigilants à vérifier la version de l'API utilisée.

Authentification

Aucune requête nécessite d'authentification pour le moment, sauf si l'instance est configurée pour demander un mot de passe lors de la création d'un transfert.

Dans ce cas, vous devrez fournir un header Authorization avec le mot de passe en clair. Par exemple, si le mot de passe est password, vous devrez fournir le header Authorization: password.

Format de réponses

Toutes les réponses de l'API sont au format JSON. Le format d'une réponse avec succès peut varier. Les erreurs sont toujours au format suivant :

{
  "statusCode": 400, // peut varier
  "error": "Titre de l'erreur",
  "message": "Description de l'erreur"
}

Rate Limit

Aucune limite de requêtes n'est imposée pour le moment, mais cela peut changer dans le futur.