Skip to content

Latest commit

 

History

History
95 lines (76 loc) · 3.23 KB

facebook.md

File metadata and controls

95 lines (76 loc) · 3.23 KB
Raw

Facebook user and page post

You will need a Facebook app to authenticate an account via OAuth2. If you do not have one set up, you can follow the instructions on the facebook app development documentation. Choose website as a platform for your app. When your app is created, go to the settings and add the domain (for example: localhost) the app will be running on in App Domains. Get your app ID and your app secret, and copy them to your settings.json file.

In your settings.json file, you'll need to add the following configuration object to the actions property:

"actions": {
  "facebook": {
    "appID": "abcd-xyz",
    "appSecret": "shhh",
    "loginURL": "/login/facebook",
    "callbackURL": "/login/facebook/return",
    "failureURL": "/",
    "successURL": "/",
    "profileURL": "/profile/facebook",
    "accountsURL": "/accounts/facebook",
    "pageID": "" // optional
  }
}
name type required description
appID string yes You're app ID
appSecret string yes You're app secret Token
pageID string no The ID of the page you need to manage

Usage

Before being able to post, you will need to log in facebook by going to the url matching loginURL in your config file (don't forget the prefix of http://localhost:6060) and authorizing the application. When logged in, you can post on your feed using JSON or form-data :

POST /api/v1/actions/facebook

curl -X POST -H "Content-Type: application/json" -d '{
  "message": "Hello Facebook!",
  "media": "/path/to/my/img.jpg"
}' "http://localhost:6060/api/v1/actions/facebook"

The 'media' option must be one of the following:

  • path to a file on your system (example: /path/to/image.png)
  • url (example: http://some_site.com/image.png)
  • base64 encoded string (soon)

Supported formats are JPG, PNG, GIF, WEBP (for images) and MOV, WMV or MP4 (for videos)

You can get your profile's informations and a list of accounts (like pages) you manage by sending a GET request to urls matching respectively profileURL and accountsURL. You will be returned JSON object containing the datas requested.

GET /profileURL

{
  "id": "xxx",
  "displayName": "xxx",
  "name": {}
}

GET /accountsURL

{
  [
    {
      "access_token": "xxx",
      "category": "xxx",
      "name": "xxx",
      "id": "xxx",
      "perms": []
    }
  ]
}

Options

Note: MP4 files MUST be local files on your system or url (no base64)

name type required description
message string if no media message to post on your feed
media string if no message image or video

You can also set message and/or media into your config directly, if they don't need to be set by the user.

You have to provide at least one of the two options (be it in config or in request).