ADDER AdderLink ALIF2000T Guide de l'utilisateur Page 41

  • Télécharger
  • Ajouter à mon manuel
  • Imprimer
  • Page
    / 48
  • Table des matières
  • DEPANNAGE
  • MARQUE LIVRES
  • Noté. / 5. Basé sur avis des utilisateurs
Vue de la page 40
 sll




40
Appendix D
AIM API
The AIM API provides access for external applications to key routines used within
the AIM server. This appendix provides a reference to the available methods.
Note: This section refers to AIM version 1.3 released 17th February 2011.
Methods
login (http://<aim.ip.address>/api/#login)
logout (http://<aim.ip.address>/api/#logout)
get_presets (http://<aim.ip.address>/api/#get_presets)
connect_preset (http://<aim.ip.address>/api/#connect_preset)
disconnect_preset (http://<aim.ip.address>/api/#disconnect_preset)
login
The API will require a valid AIM user’s login credentials to be presented in the
first request. The API will return an authentication code, which must be passed
in all future requests. This authentication code can be re-used until a logout
request is made, at which point the authentication code will no longer be valid.
The concept of an ‘anonymous user’ can apply to the API. If no login username
and password are provided, the API will return an authentication token for the
anonymous user (either the same one as for the OSD, or else an ‘anonymous API
user’ account can be created).
Input parameters:
- username
- password
- v (the AIM API version this request is designed for)
Output values:
- timestamp - the current server time
- version - the current API version number
- token - an authentication code for future API requests
Examples
Input:
/api/?v=1&method=login&username=xxxxx&password=xxxxx
Output:
<api_response>
<version>1</version>
<timestamp>2011-02-0415:26:20</timestamp>
<success>1</success>
<token>5cf494a71c29e9465a57a81e0a2d602c</token>
</api_response>
or
<api_response>
<version>1</version>
<timestamp>2011-02-0415:26:20</timestamp>
<success>0</success>
<errors>
<error>
<code>2</code>
<msg>Invalidusernameorpassword</msg>
</error>
</errors>
</api_response>
This method was last updated in API version 1
Vue de la page 40
1 2 ... 36 37 38 39 40 41 42 43 44 45 46 47 48

Commentaires sur ces manuels

Pas de commentaire