This repository hosts the un-official API documentation for OSSN (Open Source Social Network) Services. It provides detailed information on all available endpoints, their methods, parameters, and example responses, enabling developers to build powerful applications on top of the OSSN platform.
The OSSN Services API provides programmatic access to the core functionalities of the Open Source Social Network platform. This documentation aims to be a comprehensive guide for developers looking to integrate with or build applications that leverage OSSN's user management, content sharing, interaction, messaging, and group features.
The API currently supports versions v1.0 and v2.0 of certain endpoints.
v1.0: Standard API endpoints.v2.0: Introduces enhancements and sometimes breaking changes for specific functionalities (e.g.,message/send,message/list,message/new,user/blocklist,group/delete,post/edit). Please refer to individual endpoint documentation for specific version details and any differences.
All API requests must include your api_key_token as a parameter (either via GET or POST). This API key is essential for authenticating your requests.
The API is organized into several categories for easier navigation:
user_add: Add a new user to the system.user_authenticate: Authenticate a user with username/email and password.user_details: Retrieve basic profile details for a user.user_edit: Edit a user's profile information.user_delete: Permanently delete a non-admin user. (v2.0)user_friends: Get a list of a user's friends.user_add_friend: Send or accept a friend request.user_remove_friend: Remove a friend connection.user_friend_requests: Get pending friend requests for a user.user_is_friend: Check if two users are friends.user_blocklist: Get a list of users blocked by a specific user. (v2.0)
wall_add: Add a new wall post (text and/or photo) for a user or group.wall_edit: Edit the text content of an existing wall post. (v2.0, original filepost_edit.md)wall_delete: Delete an existing wall post.wall_list_home: List newsfeed wall posts.wall_list_user: List wall posts for a user's profile.wall_list_group: List wall posts for a specific group.wall_view: Retrieve details of a single wall post.photos_album_create: Create a new photo album for a user.photos_album_add: Add a photo to an existing album.photos_list_albums: List all albums owned by a user.photos_list: List photos within a specific album (excluding profile/cover).photos_view: Get details for a standard album photo.photos_view_profile: Get details for a profile or cover photo.photos_list_profile_cover: List photos from a user's profile or cover photo albums.photos_profile_add: Change a user's profile photo.photos_cover_add: Change a user's cover photo.photos_delete: Delete a standard album photo.photos_delete_profile: Delete a specific profile photo.photos_delete_cover: Delete a specific profile cover photo.
like_add: Create a like for a post, entity, or annotation.unlike_set: Remove a like from a post, entity, or annotation.comment_add: Add a comment to a post, entity, or object.comment_edit: Edit the text of an existing comment.comment_delete: Delete a comment.comments_list: Retrieve comments for an entity, object, or post.
message_add: Send a message to a user.message_send_2_0: Send a message with attachment support. (v2.0)message_list: Get a paginated list of messages exchanged between two users.message_list_2_0: Get a paginated list of messages (v2.0, includesis_onlinestatus).message_recent: Get a list of recent message conversations.message_new_unread: Get unread messages between two users. (v2.0, includesis_onlinestatus)message_new_unread_v1: Get unread messages between two users. (v1.0)
groups_add: Create a new group.groups_edit: Edit an existing group's details.group_delete: Permanently delete a group and its content. (v2.0)groups_members: Get a list of members for a group.groups_user_memberof: Retrieve all groups a user is a member of.groups_unjoin: Unjoin a specific group.groups_requests: Retrieve pending group member requests.groups_request_accept: Accept a member request for a group.groups_request_decline: Decline a member request for a group.
notifications_count: Count notifications (general, messages, friend requests) for a user.notifications_list_user: Fetch a list of user notifications.notifications_mark_viewed: Mark a specific notification as viewed.
components_list_enabled: List all enabled (active) components for the OSSN installation.
To utilize this API, you will need:
- An OSSN Installation: The API endpoints refer to your OSSN installation's base URL (e.g.,
http://www.mywebsite.com/). - An API Key: All requests require an
api_key_token. Refer to your OSSN Services configuration to obtain this key.
Detailed usage examples, including parameters and example responses, can be found within each endpoint's respective Markdown file in the docs/endpoints/ directory.