Skip to content
On this page

Facebook API

EndpointMethodDescription
/api/v0/rpc/fb.updateTokenjsonRpcUpdate token
/api/v0/rpc/fb.getUserAlbumsjsonRpcGet user albums
/api/v0/rpc/fb.getUserPhotosjsonRpcGet user photos
facebook:updateTokenwebsocketUpdate facebook token
facebook:getAlbumswebsocketGet facebook albums
facebook:getPhotoswebsocketGet facebook photos

Update token

Method: jsonRpc

HTTP Method: POST

Path: /api/v0/rpc/fb.updateToken

Headers:

X-Session-Id: sessionToken

Request:

{
    "User": string
    "Token": string
    "Scopes": [ string ]
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Get user albums

Method: jsonRpc

HTTP Method: POST

Path: /api/v0/rpc/fb.getUserAlbums

Headers:

X-Session-Id: sessionToken

Request:

{
    "User": string
    "Album": string
    "Offset": int
    "Limit": int
}

Response:

{
    "data": {
        "albums": [{
            "remoteId": string
            "title": string
            "description": string
            "thumbnail": string
            "metadata": {
                "fileDate": timestamp
                "contentType": string
                "link": string
            }
            "count": int
        }]
        "next": bool
        "offset": int
        "limit": int
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get user photos

Method: jsonRpc

HTTP Method: POST

Path: /api/v0/rpc/fb.getUserPhotos

Headers:

X-Session-Id: sessionToken

Request:

{
    "User": string
    "Album": string
    "Offset": int
    "Limit": int
}

Response:

{
    "data": {
        "photos": [{
            "remoteId": string
            "title": string
            "description": string
            "thumbnail": string
            "metadata": {
                "fileDate": timestamp
                "contentType": string
                "link": string
            }
        }]
        "next": bool
        "offset": int
        "limit": int
    }
    "error": { "status": bool, "code": int, "message": string }
}

Update facebook token

Method: websocket

Endpoint: facebook:updateToken

Request:

{
    "data": {
        "token": string
        "scopes": [ string ]
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "error": { "status": bool, "code": int, "message": string }
}

Get facebook albums

Method: websocket

Endpoint: facebook:getAlbums

Request:

{
    "data": {
        "album": string
        "offset": int
        "limit": int
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "data": {
        "albums": [{
            "remoteId": string
            "title": string
            "description": string
            "thumbnail": string
            "metadata": {
                "fileDate": timestamp
                "contentType": string
                "link": string
            }
            "count": int
        }]
        "next": bool
        "offset": int
        "limit": int
    }
    "error": { "status": bool, "code": int, "message": string }
}

Get facebook photos

Method: websocket

Endpoint: facebook:getPhotos

Request:

{
    "data": {
        "album": string
        "offset": int
        "limit": int
    }
    "event": { "id": string, "date": timestamp }
}

Response:

{
    "data": {
        "photos": [{
            "remoteId": string
            "title": string
            "description": string
            "thumbnail": string
            "metadata": {
                "fileDate": timestamp
                "contentType": string
                "link": string
            }
        }]
        "next": bool
        "offset": int
        "limit": int
    }
    "error": { "status": bool, "code": int, "message": string }
}