Confirmed users
169
edits
Services/F1/Server/API: Difference between revisions
Jump to navigation
Jump to search
no edit summary
Mixedpuppy (talk | contribs) No edit summary |
Mixedpuppy (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
Status: brain dump | Status: brain dump | ||
=== Dependencies === | |||
* Portable Contacts. All profile or contact data is in Portable Contacts format. | |||
=== Security === | === Security === | ||
| Line 79: | Line 83: | ||
The status codes generally follow HTTP status codes. | The status codes generally follow HTTP status codes. | ||
Status codes: | |||
*200: ok, message sent, response object in body, used for synchronous calls | |||
*202: message has been queued, client must call response api to find the result | |||
*401: authorization required (e.g. oauth tokens may be expired) | |||
*502: remote service (e.g. twitter) is temporarily unavailable, try again later | |||
*503: share service is temporarily unavailable | |||
==== POST /send ==== | ==== POST /send ==== | ||
| Line 103: | Line 116: | ||
Any number of other parameters may be sent. They will be silently dropped by any given service implementation if the parameter is not understood. | Any number of other parameters may be sent. They will be silently dropped by any given service implementation if the parameter is not understood. | ||
==== POST /contacts ==== | |||
The contacts api is used to retrieve the users contacts for a given service. The contacts are used to provide direct sharing functionality. | |||
Request Arguments: | |||
*domain (string): The domain of the service to get contacts from (e.g. google.com) | |||
*username (string): The user name used by the service. The username or userid is required if more than one account is setup for the service. | |||
*userid (string): The user id used by the service. The username or userid is required if more than one account is setup for the service. | |||
*startindex (integer): Start index used for paging results. | |||
*maxresults (integer): Max results to be returned per request, used with startindex for paging. | |||
*group (string): Name of the group to return. | |||
*account (object): json formatted account object retrieved during OAuth authorization | |||
Successful responses will contain a POCO formatted response object: | |||
{ | |||
'entry': array of poco objects, | |||
'itemsPerPage': items_per_page, | |||
'startIndex': start_index, | |||
'totalResults': total_results, | |||
} | |||
See Portable Contacts for more details. | |||
==== GET /response ==== | ==== GET /response ==== | ||