[VLT] Wizz.cc : API Unifiée pour les Nabaztag & Karotz

L' API unifiée Wizz.cc, basée sur l'ancien modèle Violet, est mise à disposition pour les développeurs Nabaztag & Karotz. Elle permet de communiquer de façon transparente avec les uns et les autres quel que soit leur serveur de rattachement du Lapin.

Cette API permet en outre d'intégrer très facilement les fonctionalités de messagerie instantanée, pour les Karotz, dans les applications et les sites web.

Exemple :

• Nabaztag : http://api.wizz.cc/?sn=001234567899&token=abcd-123&server=violet&tts=Bonjour+mon+lapin.&voice=fr
  
• Karotz : http://api.wizz.cc/?sn=Bunny&token=12345&tts=Hello+bunny.&voice=en
  

---

Url : http://api.wizz.cc/
Retour : un message texte indiquant le résultat obtenu par l'api.

Paramètres :

• sn : le pseudo du lapin. Pour les Nabz c'est le "serial_number" s/n à 12 cars. 0-9A-F (équivalent à l'adresse MAC). Ex: 0012345678AE. Pour les Karotz, c'est le pseudo indiqué lors de la configuration de l'appli Live Chat !
  
  
• token : un code de confidentialité pour limiter les envois non autorisés. Pour les Nabz, activé ou pas en fonction des serveurs... (voir le panneau d'admin de votre lapin sur OJN). Pour les Karotz, c'est le token indiqué lors de la configuration du Live Chat !
  
  
• server : Uniquement pour les Nabz. Depuis l'ouverture des serveurs alternatifs Nabz, il faut désormais connaitre, outre le s/n, le nom du serveur qui héberge le Nabz. Actuellement : violet | pixel | alexjd (ou nappey) | alfinium | carsso | datagutt | don | htristra | lgnap | lolodu78 | mine | nag | poupou | ticed. Cependant, il existe un annuaire central des Nabaztags que l'Api peut interroger pour récupérer automatiquement le nom du serveur associé au lapin (sauf pour le serveur violet). Si ce paramètre est omis alors s'assurer que le nabaztag est bien inscrit dans l'annuaire central des serveurs OJN.
  
  
• check : Pour les Karotz uniquement. Vérifie si le Karotz est bien en ligne et disponible ! http://api.wizz.cc/?sn=Bunny&token=&check
  
  
• tts : Le message à lire. Ne pas oublier le point '.' à la fin des phrases. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&tts=Pizza+del+arte.&voice=it
  
  
• voice : la voix à utiliser. Pour les Nabaztag, le service de synthétisation Google (limité à 100 caractères) est utilisé avec les voix : fr | en | es | de | it. Pour les Karotz, le service "Karotz" est utilisé (sans limitation apparente) avec les voix : fr | en | en | de.
  
  
• ws_kajedo (ou voicemp3 pour compatibilité) : voix supplémentaires de synthèse pour le français (limité à 1.024 caractères). Dans ce cas, ne pas indiquer le paramètre voice précédent.
  Voix : bicool | chuchotement | darkvadoor | electra | guy_vieux | guy_voix_basse | guy_fort | guy_grave | helium | juliexp | julieEnfant | Loic | mamie | matteo | nono | papanoel | philippe | ramboo | sidoo.
  http://api.wizz.cc/?sn=Bunny&token=12345&tts=Bonjour+bunny.&ws_kajedo=electra
  
  
• ws_acapela : 50 voix supplémentaires de synthèse pour 25 langues différentes (limité à 1.024 caractères). Dans ce cas, ne pas indiquer les paramètres voice et ws_kajedo précédents.
  Voix : Arabic : Leila - Leila (Female) | Mehdi - Mehdi (Male) | Nizar - Nizar (Male) | Nizareng - Nizar - English (Male) | Salma - Salma (Female) | Youssef - Youssef (Male). Catalan : Laia - Laia (Female). Czech : Eliska - Eliska (Female). Danish : Mette - Mette (Female) | Rasmus - Rasmus (Male). Dutch (B) : Jeroen - Jeroen (Male) | Sofie - Sofie (Female) | Zoe - Zoe (Female). Dutch (NL) : Daan - Daan (Male) | Femke - Femke (Female) | Jasmijn - Jasmijn (Female) | Max - Max (Male). English (India) : Deepa - Deepa (Female). English (UK) : Graham - Graham (Male) | Lucy - Lucy (Female) | Peter - Peter (Male) | Rachel - Rachel (Female). English (US) : Heather - Heather (Female) | Kenny - Kenny - Child (Male) | Laura - Laura (Female) | Nelly - Nelly - Child (Female) | Ryan - Ryan (Male) | Tracy - Tracy (Female). Faeroese : Sjurdur - Sjurdur (Male). Finnish : Sanna - Sanna (Female). French : Alice - Alice (Female) | Antoine - Antoine (Male) | Bruno - Bruno (Male) | Claire - Claire (Female) | Julie - Julie (Female) | Margaux - Margaux (Female). French (Canadian) : Louise - Louise (Female). German : Andreas - Andreas (Male) | Julia - Julia (Female) | Klaus - Klaus (Male) | Sarah - Sarah (Female). Greek : Dimitris - Dimitris (Male). Icelandic : Snorri - Snorri (Male). Italian : Chiara - Chiara (Female) | Fabiana - Fabiana (Female) | Vittorio - Vittorio (Male). Japanese (Q42011) : Sakura - Sakura (Female). Norwegian : Bente - Bente (Female) | Kari - Kari (Female) | Olav - Olav (Male). Polish : Ania - Ania (Female). Portuguese : Celia - Celia (Female). Portuguese (Brazil) : Marcia - Marcia (Female). Russian : Alyona - Alyona (Female). Spanish : Antonio - Antonio (Male) | Ines - Ines (Female) | Maria - Maria (Female). Spanish (North America) : Rosa - Rosa (Female). Swedish : Elin - Elin (Female) | Emil - Emil (Male) | Emma - Emma (Female) | Erik - Erik (Male). Swedish (Finland) : Samuel - Samuel (Male). Turkish : Ipek - Ipek (Female).
  http://api.wizz.cc/?sn=001234567899&token=&server=pixel&tts=Hello+bunny.&ws_acapela=ryan
  
  
• noforge (ou novoice) : Ne pas forger la synthèse mais transférer directement au serveur OJN. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&tts=Bonjour+mon+lapin.&noforge
  
  
• posleft : bouger l'oreiller gauche jusqu'à la position 0 à 16. Non applicable pour les Karotz, puisque ses oreilles sont réajustées à chaque fin de session. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&posleft=5&posright=0
  
• posright : bouger l'oreiller droite jusqu'à la position 0 à 16.
  
  
• urlList : Indique un fichier mp3 à jouer. Pour les Nabaztag, possibilité d'indiquer plusieurs fichiers mp3 en les séparant par un pipe |. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&urlList=xxx.mp3
  
  
• chor : Envoi d'une chorégraphie. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&chor=10,0,motor,1,20,0,0,0,motor,0,20,0,0,1,led,0,0,238,0
  
  
• action : Envoi d'une action. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&action=10&strip
  Action = 4 (Timezone) | 7 (Sleep ? yes/no) | 8 (V2) | 10 (Bunny Name) | 13 (Wake-up) | 14 (Go to bed)
  
  plus
  
  
• utf8 : Par défaut, l'API attend du texte brut et non pas de l'utf-8. Si vous encodez en utf-8 (utf8_encode()) alors ajouter le param &utf8=1 à la fin de l'url.
  
  
• apiz : Si vous surchargez (par un utf8_encode()) un texte apparemment déjà encodé (souvent en provenance d'un navigateur) et que le rendu n'est pas celui escompté, tenter l'ajout du param &apiz=1 à la fin de l'url. Sinon, traitez le texte en amont avant de le renvoyer vers l'api.
  
  
• silent : Masque les infos rajoutées par Wizz (ex. [server] ) devant le message retourné par l'API. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&tts=Bonjour+mon+lapin.&voice=fr&silent
  
  
• strip : Enlève les tags html, xml... strip_tags() du message retourné par l'API. http://api.wizz.cc/?sn=001234567899&token=&server=pixel&tts=Bonjour+mon+lapin.&voice=fr&silent&strip
  
  
• short : Ne renvoie que la première partie, en mode texte, rsp->message de la réponse xml retourné par l'API :

  Code:

  <rsp><message>EARPOSITIONSENT</message><comment>Your ears command has been sent</comment></rsp>

  
  
• noxml : Transforme la réponse xml retournée par l'API en mode texte. Différent de strip, car on s'interesse ici uniquement à rsp->message et rsp->comment.
  
  

Notes :

De nombreuses voix étrangères sont testées régulièrement ainsi que de nouveaux (web)services de synthétisation... Ils apparaisent au fur et à mesure. D'autres services peuvent aussi être désactivés... Ces services de synthétisation ne sont pas entièrement garantis sur le (très) long terme, les licences d'utilisation étant pour l'instant "trial". Elles sont néanmoins remplacées au fur et à mesure des évolutions, des besoins... et des moyens.

D'une façon générale, c'est l'API qui forge la synthèse, et non pas le serveur OJN. Ce qui permet d'ajouter de nombreuses voix ou variantes sans toucher à la configuration de chacun des serveurs en place...

Si aucune voix n'est passée en paramètre OU qu'une voix n'existe pas OU que la synthèse ne s'effectue pas correctement, alors le texte est transféré directement au serveur OJN comme avec le paramètre noforge.

---

Fonctions supplémentaires :

• 7 Plugin Mails : GMail+Yahoo+HotMail et Free+Orange+Sfr+BBox.
  
  
• Nabaztag : http://api.wizz.cc/?list_ojn=select (format= xml|json|select|sep) liste les serveurs OJN recensés par l'API sous la forme d'une liste d'options.
  
  
• Karotz : http://api.wizz.cc/?list=select (format = xml|select|ul|ol|sep) liste les Karotz abonnés au service du Live Chat !
  

On en discute ici :
https://nabaztag.forumactif.fr/t13483-ojn-wizzcc-api-unifiee-pour-les-nabaztag-karotz