Référence

Tous les détails dont vous avez besoins

API

L'api d'Edu-Focus fonctionne selon le principe REST avec le protocole HTTPS. Tous les accès à l'api se font avec la racine:

https://api.edu-focus.org/

L'api dispose de plusieurs versions, par défaut la version utilisée est celle avec un ✔ à coté d'elle. Si vous souhaitez utiliser une autre version que celle par défaut, vous pouvez y accéder via l'url https://api.edu-focus.org/v{version}.

Version

Status

Actuelle

1

Dépréciée

2

Disponible

Authentification

Tous les endpoints de l'api requièrent une authentification. Il y a deux manières de s'authentifier auprès de l'api:

  • En utilisant l'authentification basique avec l'id de votre application comme identifiant et le secret comme mot de passe. Détails [EN]

  • En utilisant un token Bearer obtenu via OAuth, pour savoir comment utiliser OAuth, rendez vous sur cette page.

Peu importe la méthode, vous devez passer votre token d'autorisation avec le header Authorization.

Accès direct
Via un token OAuth
Accès direct
Authorization: Basic Q2VjaSBlc3QgZXZpZGVtZW50IHVuIGZhdXggdG9rZW4=
Via un token OAuth
Authorization: Bearer vJejUluQsWnw4BSwrCzARHnFoyCqF7RlXRdWF25N

L'accès au fichier de demande pas de header d'autorisations

Interragir avec l'api

L'api fonctionne sous le principe REST (REpresentational State Transfer). Pour voir tous les détails quand à la communication avec l'api et notamment les réponses, merci de consulter le sujet Communiquer avec l'API.

Sécurité

Toutes les requêtes HTTP doivent utiliser TLS (https). Les requêtes en http auront comme réponses une redirection vers la même url en https avec un code 301.

Identifiants uniques

Les identifiants uniques ou ID servent à identifier toutes les ressources, il suivent tous certains principes:

  • Ils sont toujours composés des 62 mêmes caractères: les 26 lettres de l'alphabet français en minuscule et en majuscule et les 10 chiffres arabes;

  • Ils sont sensibles à la casse (c'est à dire qu'il font la distinction entre les majuscules et les minuscules);

  • Ils sont générés de manière cryptographiquement aléatoire;

  • Ils sont uniques;

Deux ressources différentes peuvent avoir le même identifiant (ex: une application et un utilisateur).

Détails par ressource

Voici quelques informations complémentaires des spécificités des identifiants de chaque ressources.

Ressource

Longueur de l'identifiant

Expression régulière

Utilisateurs

8

^[a-zA-Z0-9]{8}$

Applications

Entre 1 et 32 (généralement 32)

^[a-zA-Z0-9]{1,32}$

Suspensions

8

^[a-zA-Z0-9]{8}$

Temps

Parfois il est nécessaire de communiquer des temps avec l'api, cela ce fait au travers de ce que l'on appelle des timestamps. Les timestamps, késako ? Les timestamps sont des nombres entiers qui représentent le temps écoulé en secondes depuis un point précis: le temps 0.

Seconde 0

Les timestamps que vous envoyez à l'api et ceux que vous recevez d'elle doivent tous avoir le même temps 0:

1 janvier 1970 à 00:00:00

Fichiers

Url d'accès

Toutes les fichier sont hébergés sur le domaine suivant:

https://edu-focus.s3.fr-par.scw.cloud

Formats

Les fichiers sont disponibles sous différents formats.

Type de fichier

Extensions disponibles

Image

png, jpg, webp

PDF

pdf

Si un fichier est disponible sous un certain format, alors toutes les extensions associés au dit format sont autorisés; par exemple une image chargera aussi bien avec l'extension png qu'avec l'extension webp.

Ressources

Dynamiques

Ce sont les ressources qui changent au fil de l'utilisation de la plateforme.

Type de ressource

Chemin d'accès

Format

Avatar

/users/avatars/{user_id}/{avatar_id}.png

Image

Image de fond

/users/backgrounds/{user_id}/{background_id}.png

Image

Statiques

Ce sont les fichiers qui sont toujours présents, tels que les images par défaut.

Ressource

Chemin d'accès

Extensions valides

Avatar par défaut

/users/avatars/default.png

Image

Fond par défaut

/users/backgrounds/default.png

Image