Inversion de contrôle API
  • 04 Mar 2024
  • 2 Minutes à lire
  • Sombre
    Lumière
  • PDF

Inversion de contrôle API

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Autorisation

L’autorisation est une authentification de base HTTP. Définissez l’en-tête d’autorisation avec base64(nom d’utilisateur :mot de passe).

Obtenir la liste des sirènes

Commander:

curl -u nom d’utilisateur :mot de passe https://demo.reconeyez.com:9620/control/v1/get_siren_list

Réponse:

  • ÉtatOK 200 :

[{"guid » :"01AD2DD41C0000C1 »,"name » :"Nouvel appareil : 2DAD »,"area » :"WINDOW TEST »,"description » :" »,"type » :"siren_v1"},{"guid » :"01E211D51A00006B »,

« name » :"Sirène : 11E2 »,"area » :"Office_guard »,"description » :" »,"type » :"siren_v1"}]

  • StatusUnauthorized 401 : « Non autorisé » : informations d’identification de l’utilisateur non valides ou contrôle de l’appareil non autorisé
  • StatusTooManyRequests 429 : « Trop de demandes » - plus de 3 demandes simultanées
  • StatusInternalServerError 500 : « Erreur de serveur interne » - erreur de gestion du serveur interne

Obtenir la liste des appareils

Commander:

curl -u nom d’utilisateur :mot de passe https://demo.reconeyez.com:9620/control/v1/get_device_list

curl -u nom d’utilisateur :mot de passe https://demo.reconeyez.com:9620/control/v1/get_device_list/{id}

Réponse:

  • ÉtatOK 200 :

[{"guid » :"01B3B2931800004D »,"name » :"Nouvel appareil : B2B3 »,"area » :"Nom de la zone »,"description » :" »,"type » :"siren_v1"},{"guid » :"01BBB99318000008 »,"name »

:"Nouvel appareil : B9BB »,"area » :"Test »,"description » :" »,"type » :"detector_hdr"},{"guid » :"016BAAC918000080 »,"name » :"Appareil de test de développement : AA6B »,"area » :"Test »,

« description » :" »,"type » :"detector_hdr_xrl"},{"guid » :"019D28EA19000096 »,"name » :"Nouvel appareil : 289D »,"area » :"Test de Kalev »,"description » :" »,"type » :"detecto

r_hdr_xrl"},{"guid » :"01D3B4441A000042 »,"name » :"Nouvel appareil : B4D3 »,"area » :"Test »,"description » :" »,"type » :"bridge_4g"}]

  • StatusUnauthorized 401 : « Non autorisé » : informations d’identification de l’utilisateur non valides ou contrôle de l’appareil non autorisé
  • StatusTooManyRequests 429 : « Trop de demandes » - plus de 3 demandes simultanées
  • StatusInternalServerError 500 : « Erreur de serveur interne » - erreur de gestion du serveur interne

Jouer à la sirène

Commander:

curl -u nom_utilisateur :mot de passe --request POST https://demo.reconeyez.com:9620/control/v1/play_siren/{id}< ?duration=10>

où:

{id} est un champ obligatoire (et correspond soit au GUID 01AD2DD41C0000C1 de l’appareil Reconeyez, soit à l’ID du compte, comme spécifié dans la description de Reconeyez.

champ)

< ?duration=10> est facultatif et, s’il est omis ou invalide, la valeur par défaut définie dans l’interface utilisateur de Reconeyez sera utilisée.

L’appel de la sirène est bloquant.

Réponse:

  • StatusOK 200 : « Sirène en jeu »
  • StatusUnauthorized 401 : « Non autorisé » : informations d’identification de l’utilisateur non valides ou contrôle de l’appareil non autorisé
  • StatusNotFound 404 : « Sirène introuvable » - pas de sirène avec un tel identifiant
  • StatusNotFound 404 : « Sirène non démarrée » - intervalle de lecture minimum non dépassé
  • StatusRequestTimeout 408 : « Délai d’attente » : 30 secondes, pas de réponse de l’appareil
  • StatusTooManyRequests 429 : « Trop de demandes » - plus de 3 demandes simultanées
  • StatusInternalServerError 500 : « Erreur de serveur interne » - erreur de gestion du serveur interne

Armer / désarmer

Commander:

curl -u nom_utilisateur :mot de passe --request POST https://demo.reconeyez.com:9620/control/v1/arm/{id}

curl -u nom_utilisateur :mot de passe --request POST https://demo.reconeyez.com:9620/control/v1/disarm/{id}

où:

{id} est un champ obligatoire (et correspond soit au GUID 01AD2DD41C0000C1 de l’appareil Reconeyez, soit à l’ID du compte, comme spécifié dans la description de Reconeyez.

champ)

L’appel d’armement/désarmement est bloquant.

Réponse:

  • StatusOK 200 : « L’état de l’appareil a changé »
  • StatusUnauthorized 401 : « Non autorisé » : informations d’identification de l’utilisateur non valides ou contrôle de l’appareil non autorisé
  • StatusRequestTimeout 408 : « Délai d’attente » : 30 secondes, pas de réponse de l’appareil
  • StatusTooManyRequests 429 : « Trop de demandes » - plus de 3 demandes simultanées
  • StatusInternalServerError 500 : « Erreur de serveur interne » - erreur de gestion du serveur interne

Cet article vous a-t-il été utile ?