Aller au contenu
Lexoh API

API de contrôle d’accès

OpenAPI JSON

Gérer les droits d’accès

Utilisez les opérations /v1/access pour les identifiants. L’ouverture et la fermeture d’un appareil sont des opérations distinctes sous /v1/device.

POST /v1/access/list

Lister les droits d’accès

Permissions requises

  • can_view_access_cards ou can_view_guests

Selon l’action, les filtres ou la ressource demandée. Ces permissions ne sont pas toutes requises pour chaque requête :

  • can_view_guests

L’authentification, la MFA et les restrictions de portée restent applicables.

Nécessite can_view_access_cards ou can_view_guests. Les restrictions du rôle et les filtres déterminent les droits visibles. Les résultats utilisent access_cards et count.

Corps de la requête JSON

ParamètreTypeDescription
pageintegerNuméro de page; valeur par défaut : 1.
page_limitintegerRésultats par page; valeur par défaut : 25.
searchstringTexte de recherche facultatif.

Exemple de requête

curl -X POST "https://your-lexoh-server.app.lexoh.com:3000/v1/access/list" \
  -H "SessionID: SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"page":1,"page_limit":25}'

Exemple de réponse

Exemple sans droit d’accès correspondant.

{
  "success": true,
  "access_cards": [],
  "count": 0
}

POST /v1/access

Consulter un droit d’accès

Permissions requises

  • can_view_access_cards ou can_view_guests

Selon l’action, les filtres ou la ressource demandée. Ces permissions ne sont pas toutes requises pour chaque requête :

  • can_view_access_cards
  • can_view_guests

L’authentification, la MFA et les restrictions de portée restent applicables.

Transmettez l’identifiant numérique du droit d’accès dans le corps JSON. Le compte doit être autorisé à consulter l’identifiant de l’utilisateur, du client ou de l’invité concerné.

Corps de la requête JSON

ParamètreTypeDescription
idintegerIdentifiant du droit d’accès; remplacez la valeur d’exemple.

Exemple de requête

curl -X POST "https://your-lexoh-server.app.lexoh.com:3000/v1/access" \
  -H "SessionID: SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":123}'

Créer, modifier et supprimer des identifiants

  • PUT /v1/access crée un droit d’accès.
  • PATCH /v1/access modifie un droit d’accès identifié par id.
  • DELETE /v1/access supprime un droit d’accès identifié par id.
  • Les écritures nécessitent la permission d’ajout, de modification ou de suppression correspondante pour les cartes d’accès ou les invités. Les champs dépendent du type d’identifiant et des entités associées.

Consulter les caméras et les enregistrements

Consultez les routes des caméras et les réponses multimédias.

API des caméras et de la vidéo →
Appeler Lexoh 1-888-401-8019