ColibriSM - API
  • Get started
  • Login
  • Social login
  • Signup
  • Reset password
  • Timeline feed
  • Profile data (2)
  • Report profile
  • Block user
  • Notification token
  • Change password
  • Refresh access token
  • Logout user
  • Verify user
  • Post & Reply (4)
  • Vote polls
  • Create swift (7)
  • Thread data (2)
  • Like / Unlike
  • Report post
  • Repost post
  • Bookmarks (2)
  • Post likes
  • Delete post
  • Search hashtags
  • Search people
  • Search posts
  • Pin post to profile
  • Update profile data
  • Avatar & Cover (3)
  • User privacy (2)
  • Follow & Unfollow
  • Fetch following
  • Fetch followers
  • Follow requests (3)
  • Get notifications
  • Delete notifications
  • Messaging (6)
  • Delete account
  • Change language
工作原理 - 1 上传媒体 - 2 删除媒体 - 3 发布 - 4 删除 - 5 获取动态 - 6 记录查看 - 7

工作原理?

若要使用我们的API创建动态,您需要了解后端的工作方式。

无法通过一次发送文本和媒体文件来创建动态,因为动态是分步创建的。

创建动态(即图片/视频故事)时的系统工作原理说明

  • 1. 首先上传1个媒体文件(视频或图片)
  • 2. 然后使用下面描述的端点发布动态

上传动态媒体

请使用此 (https://mariago.site/mobile_api/upload_swift_media) API端点上传动态媒体文件,如视频或图片


POST参数

字段 值 说明
session_id 访问令牌ID 例如: de25cc16eb00960f076...
type 媒体文件类型 (image/video) 例如: image
file 媒体文件 (图片/视频) 例如: some-selfy-picture.jpeg

成功响应 (图片上传)

{
        "code": 200,
        "message": "媒体文件上传成功",
        "data":{
            "url": "http://colibri.loc/upload/images/xxxx/xx/e7tHaq16_2d.......c5_image_swift.jpeg",
            "type": "image"
        }
    }
    

成功响应 (视频上传)

{
        "code": 200,
        "message": "媒体文件上传成功",
        "data":{
            "url": "http://colibri.loc/upload/videos/xxxx/xx/e7tHaq16_2d.......c5_image_swift.mp4",
            "type": "video"
        }
    }
    

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
    	"code": 500,
    	"message": "媒体文件缺失或无效",
    	"data": []
    }


    {
    	"code": 400,
    	"message": "媒体文件类型缺失或无效",
    	"data": []
    }

    {
    	"code": 400,
    	"message": "一个帖子不能附加超过10张图片",
    	"data": []
    }
    

删除动态媒体

请使用此 (https://mariago.site/mobile_api/delete_swift_media) API端点删除动态媒体文件

在这种情况下,您只需发送上述请求即可删除动态媒体文件,即无需附加参数的请求,因为系统会自行判断最后上传的文件并将其删除


POST参数

字段 值 说明
session_id 访问令牌ID 例如: de25cc16eb00960f076...

成功响应

{
        "code": 200,
        "data": [],
        "message": "媒体删除成功"
    }
    

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }
    

发布动态

请使用此 (https://mariago.site/mobile_api/publish_swift) API端点发布动态

创建动态的此阶段假设您已经上传了媒体文件,即动态的视频或图片。由于创建动态时需要媒体文件,而描述则可选,您可以选择是否发送描述。


POST参数

字段 值 说明
session_id 访问令牌ID 例如: de25cc16eb00960f076...
swift_text 文本消息(最多200字符) 例如: `Lorem ipsum`

成功响应

{
        "code": 200,
        "message": "动态发布成功",
        "data": []
    }
    

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }
    

删除动态

请使用此 (https://mariago.site/mobile_api/delete_swift) API端点删除动态


POST参数

字段 值 说明
session_id 访问令牌ID 例如: de25cc16eb00960f076...
swid 动态哈希ID 例如: `zpad2HalsbsLGhdI`

成功响应

{
        "code": 200,
        "message": "动态删除成功",
        "data": []
    }
    

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }
    

获取我的动态列表

请使用此 (https://mariago.site/mobile_api/get_swifts) API端点获取用户动态列表

此端点将允许您获取登录用户的所有活跃动态


GET参数

字段 值 说明
session_id 访问令牌ID 例如: de25cc16eb00960f076...

成功响应

{
        "code": 200,
        "data":[
            {
                "id": 5,
                "username": "@admin",
                "fname": "Mansur",
                "lname": "ATL",
                "avatar": "http://colibri.loc/upload/avatars/xx/xx/ZIGRH9xMQ5YXeo7s1FtI_....._thumbnail_512x512.jpeg",
                "swift":[
                    {
                        "views":[
                            "1": {
                                "id": 1,
                                "username": "@testuser",
                                "fname": "Admin",
                                "lname": "O'user",
                                "avatar": "http://colibri.loc/upload/avatars/xx/xx/ZyoImsndzRPftd1UbMW5_24_3126....e6_thumbnail_512x512.jpg",
                                "name": "Admin O'user",
                                "url": "http://colibri.loc/@testuser",
                                "time": "24秒前"
                            }
                        ],
                        "time": "19:24",
                        "type": "image",
                        "status": "active",
                        "media":{
                            "src": "http://colibri.loc/upload/images/xx/xx/lr4UGK....54450_image_swift.png"
                        },
                        "exp_time": 1623947062,
                        "text": "",
                        "seen": 0,
                        "swid": "uNpuf6SrlRzQ3xVg"
                    }
                ],
                "name": "Mansur ATL",
                "url": "http://colibri.loc/@admin",
                "is_user": true,
                "has_unseen": false
            }
        ],
        "message": "动态获取成功"
    }
    

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
        "code": 404,
        "data": [],
        "message": "暂无动态可用"
    }
    

注册Swift视图

请使用此(https://mariago.site/mobile_api/reg_swift_view) API端点来注册Swift视图

当Swift被打开时,需要使用此端点向服务器发送请求,以便系统记录Swift视图。


POST参数

字段 值 说明
session_id 访问令牌ID 例如:de25cc16eb00960f076...
user_id Swift用户ID 例如:`10`
swid Swift哈希ID 例如:`zpad2HalsbsLGhdI`

成功响应

{
        "code": 200,
        "message": "Swift视图注册成功",
        "data": []
    }
    

错误响应

{
        "code": 401,
        "data": [],
        "message": "未授权访问"
    }

    {
        "code": 400,
        "data":[],
        "message": "用户ID无效或缺失"
    }