access:trackwork_client_api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
access:trackwork_client_api [2009/09/25 00:33] mmatthews |
access:trackwork_client_api [2012/10/10 17:11] (current) |
||
|---|---|---|---|
| Line 41: | Line 41: | ||
| ==== Functional Components ==== | ==== Functional Components ==== | ||
| - | I would propose the we break the new Access Client into three areas of functionality: | + | I propose that we break the new Access Client into three areas of functionality: |
| - Library functions | - Library functions | ||
| - Server functions | - Server functions | ||
| Line 69: | Line 69: | ||
| * Functions for managing vehicles (create, update, delete) | * Functions for managing vehicles (create, update, delete) | ||
| - Association API | - Association API | ||
| - | * Functions for managing asset/vehicle associations (create, update, delete) | + | * Functions for managing device/asset associations (create, update, delete) |
| - Admin API (may only be implemented in the Java library) | - Admin API (may only be implemented in the Java library) | ||
| * Functions for managing customers | * Functions for managing customers | ||
| Line 75: | Line 75: | ||
| * Functions for adding/assigning devices to customers | * Functions for adding/assigning devices to customers | ||
| * Functions for managing TMM configuration | * Functions for managing TMM configuration | ||
| - | * Functions for managing the AccessServer | + | * Functions for managing the Access Server |
| - | * Functions for monitoring/trouble shooting the AccessServer | + | * Functions for monitoring/trouble shooting the Access Server |
| + | |||
| + | If we decide to allow customers to administrate their own users then I would break the Admin API up as follows: | ||
| + | - Admin API (customer access) | ||
| + | * Functions for managing users | ||
| + | - Support API (Agtek support access) | ||
| + | * Functions for managing customers | ||
| + | * Functions for adding/assigning devices to customers | ||
| + | * Functions for managing TMM configuration | ||
| + | * Functions for managing the Access Server | ||
| + | * Functions for monitoring/trouble shooting the Access Server | ||
| + | |||
| + | |||
| + | ==== API Access ==== | ||
| + | |||
| + | Access to the various API would be allowed as follows: | ||
| + | |||
| + | === Connected but not Authenticated === | ||
| + | This state occurs after a connection is made to the server but before authentication information has been sent. This is how devices will send data to the Access Server. The only API enabled will be the Track API, however all functions except upload will return an error. | ||
| + | |||
| + | === Connected and Authenticated === | ||
| + | This state occurs after a connection is made to the server and the user has been authenticated. Based on the user information returned by the server the library will enable APIs for subscribed services. | ||
| + | |||
| + | === Authenticated with Admin Privelages === | ||
| + | This state occurs when an authenticated user has admin privelages. If we decide to allow customers to administrate their own users then this may further break down into two levels: Customer based admin and Agtek support level admin. If we decide to do this then I think we have two levels of API, Admin API (customer admin) and Support API (Agtek support). | ||
access/trackwork_client_api.1253838812.txt.gz · Last modified: 2012/10/10 17:11 (external edit)
Page Tools
