API - Téléphone (app mobile)
API - Téléphone (app mobile)
Cette page explique comment retrouver, depuis votre propre code, un téléphone sur lequel tourne l'application mobile Phyling. Un téléphone se consomme ensuite comme un Maxi (voir API - Temps réel), à une différence près : son numéro de série n'est pas fixe. On le retrouve à partir de l'identifiant de l'appareil (uid), qui, lui, ne change pas.
1. Préparer le téléphone
- Ouvrez l'application Phyling et connectez-vous à votre compte.
- Sur la page Temps réel, appuyez sur l'icône nuage pour vous connecter au serveur. Le téléphone apparaît alors en ligne dans l'application web.
- Ouvrez Réglages > Appareil : vous y trouvez l'identifiant de l'appareil (uid), de la forme
51XX-XXXX-XXXX-XXXX, avec un bouton Copier. - Laissez l'application ouverte : hors enregistrement, le téléphone n'est en ligne que tant que l'application est au premier plan. Pendant un enregistrement, le téléphone peut être verrouillé.
Utilisez toujours l'uid en majuscules, avec les tirets (
51XX-XXXX-XXXX-XXXX), partout (REST et Socket.IO).
L'uid est propre à l'installation de l'application : copiez-le une fois et utilisez-le dans votre code. Le numéro de série du téléphone peut changer : ne le codez pas en dur.
2. Retrouver le device à partir de l'uid
GET /devices/uid/{uid}
Authorization: Bearer <access_token> || ApiKey <key>Réponse 200 :
{
"uid": "51AB-CDEF-GHJK-MNPQ",
"number": 51100001,
"client_id": 2
}number (numéro de série) et client_id sont les valeurs à utiliser dans toutes les routes /devices/rt/{client_id}/{device_number}/.... La route répond même si le téléphone n'est pas connecté.
| Code | Signification |
|---|---|
400 | uid mal formé. |
401 | Authentification manquante ou invalide. |
403 | Vous n'avez pas les droits temps réel sur le client du téléphone. |
404 | uid inconnu. |
410 | Aucun device actif pour cet uid : l'application doit être ouverte sur le téléphone. Le corps contient un message { "fr": "...", "en": "..." }. |
3. Suivre le device en temps réel
Une fois le numéro de série connu, suivez le tutoriel Maxi habituel : API - Temps réel.
Quand le numéro de série change
Le numéro de série est lié au compte connecté sur le téléphone. Il change :
- quand un autre compte se connecte sur le téléphone : chaque compte a son propre numéro, et le téléphone reprend l'ancien si le premier compte se reconnecte ;
- après 60 jours sans connexion : le téléphone reçoit un nouveau numéro à sa connexion suivante.
L'uid, lui, ne change pas. Rappelez donc GET /devices/uid/{uid} à chaque démarrage de votre code, et quand le téléphone repasse en ligne après une déconnexion, puis reprenez le tutoriel temps réel avec le number obtenu.