API AccessToken

Vue d’ensemble

L’API AccessToken permet de gerer les jetons d’acces API de Fess. Vous pouvez creer, mettre a jour et supprimer des jetons.

URL de base

/api/admin/accesstoken

Liste des endpoints

Methode Chemin Description
GET/PUT /settings Obtention de la liste des jetons d’acces
GET /setting/{id} Obtention d’un jeton d’acces
POST /setting Creation d’un jeton d’acces
PUT /setting Mise a jour d’un jeton d’acces
DELETE /setting/{id} Suppression d’un jeton d’acces

Obtention de la liste des jetons d’acces

Requete

GET /api/admin/accesstoken/settings
PUT /api/admin/accesstoken/settings

Parametres

Parametre Type Requis Description
size Integer Non Nombre d’elements par page (par defaut : 20)
page Integer Non Numero de page (commence a 0)

Reponse

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "token_id_1",
        "name": "API Token 1",
        "token": "abcd1234efgh5678",
        "parameterName": "token",
        "expiredTime": 1735689600000,
        "permissions": ["admin"]
      }
    ],
    "total": 5
  }
}

Obtention d’un jeton d’acces

Requete

GET /api/admin/accesstoken/setting/{id}

Reponse

{
  "response": {
    "status": 0,
    "setting": {
      "id": "token_id_1",
      "name": "API Token 1",
      "token": "abcd1234efgh5678",
      "parameterName": "token",
      "expiredTime": 1735689600000,
      "permissions": ["admin"]
    }
  }
}

Creation d’un jeton d’acces

Requete

POST /api/admin/accesstoken/setting
Content-Type: application/json

Corps de la requete

{
  "name": "Integration API Token",
  "parameterName": "token",
  "permissions": ["user"]
}

Description des champs

Champ Requis Description
name Oui Nom du jeton
token Non Chaine du jeton (genere automatiquement si non specifie)
parameterName Non Nom du parametre (par defaut : « token »)
expiredTime Non Date d’expiration (temps Unix en millisecondes)
permissions Non Roles autorises

Reponse

{
  "response": {
    "status": 0,
    "id": "new_token_id",
    "token": "generated_token_string",
    "created": true
  }
}

Mise a jour d’un jeton d’acces

Requete

PUT /api/admin/accesstoken/setting
Content-Type: application/json

Corps de la requete

{
  "id": "existing_token_id",
  "name": "Updated API Token",
  "parameterName": "token",
  "expiredTime": 1767225600000,
  "permissions": ["user", "editor"],
  "versionNo": 1
}

Reponse

{
  "response": {
    "status": 0,
    "id": "existing_token_id",
    "created": false
  }
}

Suppression d’un jeton d’acces

Requete

DELETE /api/admin/accesstoken/setting/{id}

Reponse

{
  "response": {
    "status": 0,
    "id": "deleted_token_id",
    "created": false
  }
}

Exemples d’utilisation

Creation d’un jeton API

curl -X POST "http://localhost:8080/api/admin/accesstoken/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "External App Token",
       "parameterName": "token",
       "permissions": ["guest"]
     }'

Appel API utilisant un jeton

# Utiliser le jeton comme parametre
curl "http://localhost:8080/json/?q=test&token=your_token_here"

# Utiliser le jeton dans l'en-tete Authorization
curl "http://localhost:8080/json/?q=test" \
     -H "Authorization: Bearer your_token_here"

Informations complementaires