This add-on is operated by SandKlock
SocialAll is ONE API for all Social Network APIs.
SocialAll
Last updated January 30, 2017
This article is a work in progress, or documents a feature that is not yet released to all users. This article is unlisted. Only those with the link can access it.
The SocialAll add-on is currently in beta.
Table of Contents
SoclAll is an add-on for providing an API that allows you to connect your users to their social network accounts and access anything they are sharing.
SoclAll unifies other social network APIs into one API. It includes:
- Login, which allows users to use their existing social account to connect to your website.
- Contact, which focuses on collecting contact and friend lists of all of the user’s connected social networks.
- Sharing, which helps user activities go viral on a connected network in realtime.
Provisioning the add-on
SoclAll can be attached to a Heroku application via the CLI:
$ heroku addons:create soclall
-----> Adding soclall to sharp-mountain-4005... done, v18 (free)
A list of all plans available can be found here.
Once SoclAll has been added, a SOCLALL_APP_ID
setting and a SOCLALL_SECRET_KEY
setting will be available in the app configuration. SOCLALL_APP_ID
contains the app id and SOCLALL_SECRET_KEY
contains the secret key that allows you access to SoclAll API. This can be confirmed using the heroku config:get
command.
$ heroku config:get SOCLALL_APP_ID
54c1cd165f0c9ea42e98741b
The SoclAll API is accessible via HTTP request and has supported client libraries for Node.js and PHP.
Using with Node.js
npm install soclall-api --save
For more information and examples, refer to our API Reference.
Using with PHP
Clone from https://github.com/sandklock/soclall-api-php
.
For more information and examples, refer to our API Reference.
Get the user’s token
Before you can access the user’s data, redirect the user to the login URL to verify your application.
REDIRECT https://api.soclall.com/login/{network}/
Parameter | Description |
---|---|
app_id | Your application’s id. |
callback | Callback URL to retrieve the user’s token. |
After the user is authenticated, you can retrieve the user’s token
from the callback
URL that you provided in login URL.
API endpoint
Each API has its configurations that you must set up using the SoclAll Dashboard.
For more information and examples, refer to our API Reference.
/user
This endpoint retrieves user information.
GET https://api.soclall.com/user
Parameter | Description |
---|---|
token | User’s token |
/friends
This endpoint retrieves the user’s friends.
GET https://api.soclall.com/friends
URL parameters
Parameter | Description |
---|---|
token | User’s token |
/message
This endpoint will send message
to the user’s friends.
GET https://api.soclall.com/message
URL parameters
Parameter | Description |
---|---|
token | User’s token |
message | Message content |
friends | Comma-delimited list of friend IDs |
title | Title (required field for LinkedIn and Tumblr) |
title
is a required field for LinkedIn and Tumblr
/publish
This endpoint will publish a message to the user’s wall, timeline or stream.
GET https://api.soclall.com/publish
Parameter | Description |
---|---|
token | User’s token |
message | Message |
Dashboard
The SoclAll dashboard allows you to check summary stats and the current state of your SoclAll application.
The dashboard can be accessed via the CLI:
$ heroku addons:open soclall
Opening soclall for sharp-mountain-4005…
Migrating between plans
Application owners should carefully manage the migration timing to ensure proper application function during the migration process.
Use the heroku addons:upgrade
command to migrate to a new plan.
$ heroku addons:upgrade soclall:newplan
-----> Upgrading soclall:newplan to sharp-mountain-4005... done, v18 ($49/mo)
Your plan has been updated to: soclall:newplan
Removing the add-on
SoclAll can be removed via the CLI.
This will destroy all associated data and cannot be undone!
$ heroku addons:destroy soclall
-----> Removing soclall from sharp-mountain-4005... done, v20 (free)
Support
All SoclAll support and runtime issues should be submitted via one of the Heroku Support channels. Any non-support related issues or product feedback is welcome by email at support@soclall.com.