X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2Fapi.md;h=b759b4697c0dbd51721745f2102939bbca8deed0;hb=7849b3f8e32e49be1bf44f904356c9203b92855c;hp=147c8b7513c8c980619b1dd13e3c2491979c90c0;hpb=5b25a012c8582755ae5dfe92101fce57a27c4971;p=friendica.git
diff --git a/doc/api.md b/doc/api.md
index 147c8b7513..b759b4697c 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -1,12 +1,30 @@
-Implemented API calls
+Friendica API
===
-The Friendica API aims to be compatible to the [GNU Social API](http://skilledtests.com/wiki/Twitter-compatible_API) and the [Twitter API](https://dev.twitter.com/rest/public).
+
+* [Home](help)
+
+The Friendica API aims to be compatible to the [GNU Social API](http://wiki.gnusocial.de/gnusocial:api) and the [Twitter API](https://dev.twitter.com/rest/public).
Please refer to the linked documentation for further information.
## Implemented API calls
### General
+#### HTTP Method
+
+API endpoints can restrict the method used to request them.
+Using an invalid method results in HTTP error 405 "Method Not Allowed".
+
+In this document, the required method is listed after the endpoint name. "*" means every method can be used.
+
+#### Auth
+
+Friendica supports basic http auth and OAuth 1 to authenticate the user to the api.
+
+OAuth settings can be added by the user in web UI under /settings/oauth/
+
+In this document, endpoints which requires auth are marked with "AUTH" after endpoint name
+
#### Unsupported parameters
* cursor: Not implemented in GNU Social
* trim_user: Not implemented in GNU Social
@@ -24,17 +42,50 @@ Please refer to the linked documentation for further information.
* cid: Contact id of the user (important for "contact_allow" and "contact_deny")
* network: network of the user
-### account/rate_limit_status
-
-### account/verify_credentials
+#### Errors
+When an error occour in API call, an HTTP error code is returned, with an error message
+Usually:
+- 400 Bad Request: if parameter are missing or items can't be found
+- 403 Forbidden: if authenticated user is missing
+- 405 Method Not Allowed: if API was called with invalid method, eg. GET when API require POST
+- 501 Not Implemented: if requested API doesn't exists
+- 500 Internal Server Error: on other error contitions
+
+Error body is
+
+json:
+```
+ {
+ "error": "Specific error message",
+ "request": "API path requested",
+ "code": "HTTP error code"
+ }
+```
+
+xml:
+```
+
+ Specific error message
+ API path requested
+ HTTP error code
+
+```
+
+---
+### account/rate_limit_status (*; AUTH)
+
+---
+### account/verify_credentials (*; AUTH)
#### Parameters
+
* skip_status: Don't show the "status" field. (Default: false)
* include_entities: "true" shows entities for pictures and links (Default: false)
-### conversation/show
+---
+### conversation/show (*; AUTH)
Unofficial Twitter command. It shows all direct answers (excluding the original post) to a given id.
-#### Parameters
+#### Parameter
* id: id of the post
* count: Items per page (default: 20)
* page: page number
@@ -43,11 +94,12 @@ Unofficial Twitter command. It shows all direct answers (excluding the original
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* include_rts
-* trim_user
-* contributor_details
+* include_rts
+* trim_user
+* contributor_details
-### direct_messages
+---
+### direct_messages (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -55,19 +107,23 @@ Unofficial Twitter command. It shows all direct answers (excluding the original
* max_id: maximum id
* getText: Defines the format of the status field. Can be "html" or "plain"
* include_entities: "true" shows entities for pictures and links (Default: false)
+* friendica_verbose: "true" enables different error returns (default: "false")
#### Unsupported parameters
-* skip_status
+* skip_status
-### direct_messages/all
+---
+### direct_messages/all (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
* since_id: minimal id
* max_id: maximum id
* getText: Defines the format of the status field. Can be "html" or "plain"
+* friendica_verbose: "true" enables different error returns (default: "false")
-### direct_messages/conversation
+---
+### direct_messages/conversation (*; AUTH)
Shows all direct messages of a conversation
#### Parameters
* count: Items per page (default: 20)
@@ -76,16 +132,10 @@ Shows all direct messages of a conversation
* max_id: maximum id
* getText: Defines the format of the status field. Can be "html" or "plain"
* uri: URI of the conversation
+* friendica_verbose: "true" enables different error returns (default: "false")
-### direct_messages/new
-#### Parameters
-* user_id: id of the user
-* screen_name: screen name (for technical reasons, this value is not unique!)
-* text: The message
-* replyto: ID of the replied direct message
-* title: Title of the direct message
-
-### direct_messages/sent
+---
+### direct_messages/sent (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -93,8 +143,37 @@ Shows all direct messages of a conversation
* max_id: maximum id
* getText: Defines the format of the status field. Can be "html" or "plain"
* include_entities: "true" shows entities for pictures and links (Default: false)
+* friendica_verbose: "true" enables different error returns (default: "false")
-### favorites
+---
+### direct_messages/new (POST,PUT; AUTH)
+#### Parameters
+* user_id: id of the user
+* screen_name: screen name (for technical reasons, this value is not unique!)
+* text: The message
+* replyto: ID of the replied direct message
+* title: Title of the direct message
+
+---
+### direct_messages/destroy (POST,DELETE; AUTH)
+#### Parameters
+* id: id of the message to be deleted
+* include_entities: optional, currently not yet implemented
+* friendica_parenturi: optional, can be used for increased safety to delete only intended messages
+* friendica_verbose: "true" enables different error returns (default: "false")
+
+#### Return values
+
+On success:
+* JSON return as defined for Twitter API not yet implemented
+* on friendica_verbose=true: JSON return {"result":"ok","message":"message deleted"}
+
+On error:
+HTTP 400 BadRequest
+* on friendica_verbose=true: different JSON returns {"result":"error","message":"xyz"}
+
+---
+### favorites (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -106,87 +185,96 @@ Shows all direct messages of a conversation
* user_id
* screen_name
-Favorites aren't displayed to other users, so "user_id" and "screen_name". So setting this value will result in an empty array.
+Favorites aren't displayed to other users, so "user_id" and "screen_name" are unsupported.
+Set this values will result in an empty array.
-### favorites/create
+---
+### favorites/create (POST,PUT; AUTH)
#### Parameters
* id
* include_entities: "true" shows entities for pictures and links (Default: false)
-### favorites/destroy
+---
+### favorites/destroy (POST,DELETE; AUTH)
#### Parameters
* id
* include_entities: "true" shows entities for pictures and links (Default: false)
-### followers/ids
+---
+### followers/ids (*; AUTH)
#### Parameters
* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)
#### Unsupported parameters
* user_id
* screen_name
-* cursor
+* cursor
Friendica doesn't allow showing followers of other users.
-### friendica/photo
-#### Parameters
-* photo_id: Resource id of a photo.
-
-Returns data of a picture with the given resource.
-
-### friendica/photos/list
-
-Returns a list of all photo resources of the logged in user.
-
-### friends/ids
+---
+### friends/ids (*; AUTH)
#### Parameters
* stringify_ids: Should the id numbers be sent as text (true) or number (false)? (default: false)
#### Unsupported parameters
* user_id
* screen_name
-* cursor
+* cursor
Friendica doesn't allow showing friends of other users.
-### help/test
+---
+### help/test (*)
-### media/upload
+---
+### media/upload (POST,PUT; AUTH)
#### Parameters
* media: image data
-### oauth/request_token
+---
+### oauth/request_token (*)
#### Parameters
-* oauth_callback
+* oauth_callback
#### Unsupported parameters
-* x_auth_access_type
+* x_auth_access_type
-### oauth/access_token
+---
+### oauth/access_token (*)
#### Parameters
-* oauth_verifier
+* oauth_verifier
#### Unsupported parameters
-* x_auth_password
-* x_auth_username
-* x_auth_mode
+* x_auth_password
+* x_auth_username
+* x_auth_mode
-### statuses/destroy
+---
+### statuses/destroy (POST,DELETE; AUTH)
#### Parameters
* id: message number
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* trim_user
+* trim_user
+
+---
+### statuses/followers (*; AUTH)
+
+#### Parameters
-### statuses/followers
* include_entities: "true" shows entities for pictures and links (Default: false)
-### statuses/friends
+---
+### statuses/friends (*; AUTH)
+
+#### Parameters
+
* include_entities: "true" shows entities for pictures and links (Default: false)
-### statuses/friends_timeline
+---
+### statuses/friends_timeline (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -197,11 +285,12 @@ Friendica doesn't allow showing friends of other users.
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* include_rts
-* trim_user
-* contributor_details
+* include_rts
+* trim_user
+* contributor_details
-### statuses/home_timeline
+---
+### statuses/home_timeline (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -212,11 +301,12 @@ Friendica doesn't allow showing friends of other users.
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* include_rts
-* trim_user
-* contributor_details
+* include_rts
+* trim_user
+* contributor_details
-### statuses/mentions
+---
+### statuses/mentions (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -225,11 +315,12 @@ Friendica doesn't allow showing friends of other users.
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* include_rts
-* trim_user
-* contributor_details
+* include_rts
+* trim_user
+* contributor_details
-### statuses/public_timeline
+---
+### statuses/public_timeline (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -240,9 +331,10 @@ Friendica doesn't allow showing friends of other users.
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* trim_user
+* trim_user
-### statuses/replies
+---
+### statuses/replies (*; AUTH)
#### Parameters
* count: Items per page (default: 20)
* page: page number
@@ -251,28 +343,31 @@ Friendica doesn't allow showing friends of other users.
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* include_rts
-* trim_user
-* contributor_details
+* include_rts
+* trim_user
+* contributor_details
-### statuses/retweet
+---
+### statuses/retweet (POST,PUT; AUTH)
#### Parameters
* id: message number
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* trim_user
+* trim_user
-### statuses/show
+---
+### statuses/show (*; AUTH)
#### Parameters
* id: message number
* conversation: if set to "1" show all messages of the conversation with the given id
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* include_my_retweet
-* trim_user
+* include_my_retweet
+* trim_user
+---
### statuses/update, statuses/update_with_media
#### Parameters
* title: Title of the status
@@ -289,16 +384,17 @@ Friendica doesn't allow showing friends of other users.
* contact_deny
* network
* include_entities: "true" shows entities for pictures and links (Default: false)
-* media_ids: (By now only a single value, no array)
+* media_ids: (By now only a single value, no array)
#### Unsupported parameters
* trim_user
* place_id
* display_coordinates
-### statuses/user_timeline
+---
+### statuses/user_timeline (*; AUTH)
#### Parameters
-* user_id: id of the user
+* user_id: id of the user
* screen_name: screen name (for technical reasons, this value is not unique!)
* count: Items per page (default: 20)
* page: page number
@@ -309,43 +405,381 @@ Friendica doesn't allow showing friends of other users.
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
-* include_rts
-* trim_user
-* contributor_details
-### statusnet/config
+* include_rts
+* trim_user
+* contributor_details
+
+---
+### statusnet/config (*)
+
+---
+### statusnet/conversation (*; AUTH)
+It shows all direct answers (excluding the original post) to a given id.
+
+#### Parameter
+* id: id of the post
+* count: Items per page (default: 20)
+* page: page number
+* since_id: minimal id
+* max_id: maximum id
+* include_entities: "true" shows entities for pictures and links (Default: false)
-### statusnet/version
+---
+### statusnet/version (*)
#### Unsupported parameters
* user_id
* screen_name
-* cursor
+* cursor
Friendica doesn't allow showing followers of other users.
-### users/search
+---
+### users/search (*)
#### Parameters
-* q: name of the user
+* q: name of the user
#### Unsupported parameters
* page
* count
* include_entities
-### users/show
+---
+### users/show (*)
#### Parameters
-* user_id: id of the user
+* user_id: id of the user
* screen_name: screen name (for technical reasons, this value is not unique!)
* include_entities: "true" shows entities for pictures and links (Default: false)
#### Unsupported parameters
* user_id
* screen_name
-* cursor
+* cursor
Friendica doesn't allow showing friends of other users.
+
+## Implemented API calls (not compatible with other APIs)
+
+
+---
+### friendica/activity/
+#### parameters
+* id: item id
+
+Add or remove an activity from an item.
+'verb' can be one of:
+
+- like
+- dislike
+- attendyes
+- attendno
+- attendmaybe
+
+To remove an activity, prepend the verb with "un", eg. "unlike" or "undislike"
+Attend verbs disable eachother: that means that if "attendyes" was added to an item, adding "attendno" remove previous "attendyes".
+Attend verbs should be used only with event-related items (there is no check at the moment)
+
+#### Return values
+
+On success:
+json
+```"ok"```
+
+xml
+```true```
+
+On error:
+HTTP 400 BadRequest
+
+---
+### friendica/group_show (*; AUTH)
+Return all or a specified group of the user with the containing contacts as array.
+
+#### Parameters
+* gid: optional, if not given, API returns all groups of the user
+
+#### Return values
+Array of:
+
+* name: name of the group
+* gid: id of the group
+* user: array of group members (return from api_get_user() function for each member)
+
+
+---
+### friendica/group_delete (POST,DELETE; AUTH)
+delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.
+
+#### Parameters
+* gid: id of the group to be deleted
+* name: name of the group to be deleted
+
+#### Return values
+Array of:
+
+* success: true if successfully deleted
+* gid: gid of the deleted group
+* name: name of the deleted group
+* status: âdeletedâ if successfully deleted
+* wrong users: empty array
+
+
+---
+### friendica/group_create (POST,PUT; AUTH)
+Create the group with the posted array of contacts as members.
+
+#### Parameters
+* name: name of the group to be created
+
+#### POST data
+JSON data as Array like the result of "users/group_show":
+
+* gid
+* name
+* array of users
+
+#### Return values
+Array of:
+
+* success: true if successfully created or reactivated
+* gid: gid of the created group
+* name: name of the created group
+* status: âmissing userâ | âreactivatedâ | âokâ
+* wrong users: array of users, which were not available in the contact table
+
+
+---
+### friendica/group_update (POST)
+Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted).
+
+#### Parameters
+* gid: id of the group to be changed
+* name: name of the group to be changed
+
+#### POST data
+JSON data as array like the result of âusers/group_showâ:
+
+* gid
+* name
+* array of users
+
+#### Return values
+Array of:
+
+* success: true if successfully updated
+* gid: gid of the changed group
+* name: name of the changed group
+* status: âmissing userâ | âokâ
+* wrong users: array of users, which were not available in the contact table
+
+
+
+---
+### friendica/notifications (GET)
+Return last 50 notification for current user, ordered by date with unseen item on top
+
+#### Parameters
+none
+
+#### Return values
+Array of:
+
+* id: id of the note
+* type: type of notification as int (see NOTIFY_* constants in boot.php)
+* name: full name of the contact subject of the note
+* url: contact's profile url
+* photo: contact's profile photo
+* date: datetime string of the note
+* timestamp: timestamp of the node
+* date_rel: relative date of the note (eg. "1 hour ago")
+* msg: note message in bbcode
+* msg_html: note message in html
+* msg_plain: note message in plain text
+* link: link to note
+* seen: seen state: 0 or 1
+
+
+---
+### friendica/notifications/seen (POST)
+Set note as seen, returns item object if possible
+
+#### Parameters
+id: id of the note to set seen
+
+#### Return values
+If the note is linked to an item, the item is returned, just like one of the "statuses/*_timeline" api.
+
+If the note is not linked to an item, a success status is returned:
+
+* "success" (json) | "<status>success</status>" (xml)
+
+
+---
+### friendica/photo (*; AUTH)
+#### Parameters
+* photo_id: Resource id of a photo.
+* scale: (optional) scale value of the photo
+
+Returns data of a picture with the given resource.
+If 'scale' isn't provided, returned data include full url to each scale of the photo.
+If 'scale' is set, returned data include image data base64 encoded.
+
+possibile scale value are:
+
+* 0: original or max size by server settings
+* 1: image with or height at <= 640
+* 2: image with or height at <= 320
+* 3: thumbnail 160x160
+* 4: Profile image at 175x175
+* 5: Profile image at 80x80
+* 6: Profile image at 48x48
+
+An image used as profile image has only scale 4-6, other images only 0-3
+
+#### Return values
+
+json
+```
+ {
+ "id": "photo id"
+ "created": "date(YYYY-MM-GG HH:MM:SS)",
+ "edited": "date(YYYY-MM-GG HH:MM:SS)",
+ "title": "photo title",
+ "desc": "photo description",
+ "album": "album name",
+ "filename": "original file name",
+ "type": "mime type",
+ "height": "number",
+ "width": "number",
+ "profile": "1 if is profile photo",
+ "link": {
+ "": "url to image"
+ ...
+ },
+ // if 'scale' is set
+ "datasize": "size in byte",
+ "data": "base64 encoded image data"
+ }
+```
+
+xml
+```
+
+ photo id
+ date(YYYY-MM-GG HH:MM:SS)
+ date(YYYY-MM-GG HH:MM:SS)
+ photo title
+ photo description
+ album name
+ original file name
+ mime type
+ number
+ number
+ 1 if is profile photo
+
+
+ ...
+
+
+```
+
+---
+### friendica/photos/list (*; AUTH)
+
+Returns a list of all photo resources of the logged in user.
+
+#### Return values
+
+json
+```
+ [
+ {
+ id: "resource_id",
+ album: "album name",
+ filename: "original file name",
+ type: "image mime type",
+ thumb: "url to thumb sized image"
+ },
+ ...
+ ]
+```
+
+xml
+```
+
+
+ "url to thumb sized image"
+
+ ...
+
+```
+
+---
+### friendica/direct_messages_setseen (GET; AUTH)
+#### Parameters
+* id: id of the message to be updated as seen
+
+#### Return values
+
+On success:
+* JSON return {"result":"ok","message":"message set to seen"}
+
+On error:
+* different JSON returns {"result":"error","message":"xyz"}
+
+---
+### friendica/direct_messages_search (GET; AUTH)
+#### Parameters
+* searchstring: string for which the API call should search as '%searchstring%' in field 'body' of all messages of the authenticated user (caption ignored)
+
+#### Return values
+Returns only tested with JSON, XML might work as well.
+
+On success:
+* JSON return {"success":"true","search_results": array of found messages}
+* JSOn return {"success":"false","search_results":"nothing found"}
+
+On error:
+* different JSON returns {"result":"error","message":"searchstring not specified"}
+
+---
+### friendica/profile/show (GET; AUTH)
+show data of all profiles or a single profile of the authenticated user
+
+#### Parameters
+* profile_id: id of the profile to be returned (optional, if omitted all profiles are returned by default)
+
+#### Return values
+On success: Array of:
+
+* multi_profiles: true if user has activated multi_profiles
+* global_dir: URL of the global directory set in server settings
+* friendica_owner: user data of the authenticated user
+* profiles: array of the profile data
+
+On error:
+HTTP 403 Forbidden: when no authentication provided
+HTTP 400 Bad Request: if given profile_id is not in db or not assigned to authenticated user
+
+General description of profile data in API returns:
+* profile_id
+* profile_name
+* is_default: true if this is the public profile
+* hide_friends: true if friends are hidden
+* profile_photo
+* profile_thumb
+* publish: true if published on the server's local directory
+* net_publish: true if published to global_dir
+* description ... homepage: different data fields from 'profile' table in database
+* users: array with the users allowed to view this profile (empty if is_default=true)
+
+
+---
## Not Implemented API calls
The following API calls are implemented in GNU Social but not in Friendica: (incomplete)
@@ -368,7 +802,6 @@ The following API calls from the Twitter API aren't implemented neither in Frien
* statuses/lookup
* direct_messages/show
* search/tweets
-* direct_messages/destroy
* friendships/no_retweets/ids
* friendships/incoming
* friendships/outgoing
@@ -432,17 +865,21 @@ The following API calls from the Twitter API aren't implemented neither in Frien
* trends/closest
* users/report_spam
+---
+
+---
+
## Usage Examples
### BASH / cURL
Betamax has documentated some example API usage from a [bash script](https://en.wikipedia.org/wiki/Bash_(Unix_shell) employing [curl](https://en.wikipedia.org/wiki/CURL) (see [his posting](https://betamax65.de/display/betamax65/43539)).
- /usr/bin/curl -u USER:PASS https://YOUR.FRIENDICA.TLD/api/statuses/update.xml -d source="some source id" -d status="the status you want to post"
+/usr/bin/curl -u USER:PASS https://YOUR.FRIENDICA.TLD/api/statuses/update.xml -d source="some source id" -d status="the status you want to post"
### Python
The [RSStoFriedika](https://github.com/pafcu/RSStoFriendika) code can be used as an example of how to use the API with python. The lines for posting are located at [line 21](https://github.com/pafcu/RSStoFriendika/blob/master/RSStoFriendika.py#L21) and following.
- def tweet(server, message, group_allow=None):
- url = server + '/api/statuses/update'
- urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
+def tweet(server, message, group_allow=None):
+url = server + '/api/statuses/update'
+urllib2.urlopen(url, urllib.urlencode({'status': message,'group_allow[]':group_allow}, doseq=True))
There is also a [module for python 3](https://bitbucket.org/tobiasd/python-friendica) for using the API.