API Violet

Chaque appel nécessite au minimum deux paramètres :

  • sn (Adresse MAC)
  • token (Token d'API Violet)

API classique, Actions

Vous ne pouvez envoyer qu'une action par requête

Toutes les réponses sont au format :

<?xml version="1.0" encoding="UTF-8"?><rsp>RETURN</rsp>
Liste des amis
La fonction existe, mais l'implémentation n'est pas faite
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=2

Exemple de retour :

<listfriend nb="0"/>
Liste des messages reçus
La fonction existe, mais l'implémentation n'est pas faite
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=3

Exemple de retour :

<listreceivedmsg nb="0"/>
Récupérer la zone de temps du lapin
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=4

Exemples de retour :

<timezone>UTC</timezone>
<timezone>Europe/Paris</timezone>
Liste des utilisateurs bloqués
La fonction existe, mais l'implémentation n'est pas faite
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=6

Exemple de retour :

<blacklist nb="0"/>
Sommeil du lapin
Récupérer le statut
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=7

Retours :

<rabbitSleep>YES</rabbitSleep>
ou
<rabbitSleep>NO</rabbitSleep>
Lever
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=13

Retours :

<message><COMMANDSENT></message><comment>Your rabbit will change status</comment>
Coucher
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=14

Retours :

<message><COMMANDSENT></message><comment>Your rabbit will change status</comment>
Version du lapin
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=8

Exemple de retour :

<rabbitVersion>V2</rabbitVersion>
Voix supportées
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=9

Exemple de retour :

<voiceListTTS nb="1"/><voice lang="fr" command="nabalive/fr"/>
Nom du lapin
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=10

Exemple de retour :

<rabbitName>Bunny</rabbitName>
Lapin connecté
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=15

Retours :

<rabbitConnected>YES</rabbitConnected>
ou
<rabbitConnected>NO</rabbitConnected>
Dernière apparition en ligne
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=16

Retours :

<lastOnline>2017-08-18 12:48:28</lastOnline>
ou
<rabbitConnected>Never connected</rabbitConnected>
Rebooter le lapin
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=17

Retours :

<message><COMMANDSENT></message><comment>Bunny is going to reboot !</comment>
Redemarrer le lapin (Redemarrage calme)
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=18

Retours :

<message><COMMANDSENT></message><comment>Bunny is going to restart !</comment>
Get list of records
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&action=19

Retours :

<recordList nb="1" offset="0" limit="20"><record file="http://openjabnab.fr/ojn_local/plugins/record/record_XXXXXXXXXXXX_20170818_124828.wav"/></recordList>

API classique, Autre

Vous pouvez utiliser autant de paramètres que vous voulez par requête

Position de l'oreille gauche
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&posleft=valeur

'valeur' est une valeur entre 0 et 16

Position de l'oreille gauche
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&posright=valeur

'valeur' est une valeur entre 0 et 16

Voix pour le TTS
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&voice=claire
TTS
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&tts=Bonjour+petit+lapin

API de streaming

http://openjabnab.fr/ojn/FR/api_stream.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&urlList=http%3A%2F%2Fwww.myserver.com%2Fmusic%2Fmymusic.mp3
http://openjabnab.fr/ojn/FR/api_stream.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&urlList=http%3A%2F%2Fwww.myserver.com%2Fmusic%2Fmymusic_1.mp3|http%3A%2F%2Fwww.myserver.com%2Fmusic%2Fmymusic_2.mp3

API supplémentaire

L'API supplémentaire est limitée à 5 appels par jour pour les utilisateurs qui n'ont pas souscrit au statut premium.

Qualité de l'air
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=airquality&function=get
Horloge
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=clock&function=get
Changement de la couleur de respiration
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=colorbreathing&function=color
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=colorbreathing&function=saveandset
Journée nationale et internationale
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=dayof&function=get
Dictionnaire
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=dico&function=spell
Dicton
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=dicton&function=get
Edf Tempo
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=edftempo&function=ejp
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=edftempo&function=all
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=edftempo&function=color
Ephéméride
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=ephemeride&function=get
Langage lumineux personnalisé
Savoir inutile
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=needtoknow&function=get
Gestion des requêtes Record
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=record&function=list
Changement du volume sonore
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=sound&function=set
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=sound&function=get
Humeurs (Lecture de mp3 à intervalles aléatoires)
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=surprise&function=speak
Conditions météo et prévisions
http://openjabnab.fr/ojn/FR/api.jsp?sn=XXXXXXXXXXXX&token=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY&plugin=weather&function=get

API de openJabNab

A propos de openJabNab

Autres informations