Developer Resources

Resource Information


Method	GET
URL	https://public-api.wordpress.com/rest/v1.1/meta/external-services/$service
Requires authentication?	No

Method Parameters

Parameter	Type	Description
$service	(string)	Which service you want information about (facebook, twitter, etc). See /meta/external-services/ for list of supported services.

Query Parameters

Parameter	Type	Description
context	(string)	display: (default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc.. edit: Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope	(bool)	false: (default) true: Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty	(bool)	false: (default) true: Output pretty JSON
meta	(string)	Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields	(string)	Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback	(string)	An optional JSONP callback function.

Response Parameters

Parameter	Type	Description
ID	(string)	Service identifier.
label	(string)	Display friendly name for the service.
type	(string)	Service type (publicize or other).
description	(string)	Explanation of what the integration with this service does.
genericon	(object)	Object containing the class name and unicode character used for the genericon or noticon icon for this service.
icon	(string)	2x PNG of the icon if genericons cannot be used.
connect_url	(string)	The URL for connecting a new Keyring connection with this service.
multiple_external_user_ID_support	(bool)	Does this service support setting a non-default value for the external user ID (e.g. a Facebook page or Tumblr non-default blog) to be used as the publicize connection?
jetpack_support	(bool)	Is this service supported in Jetpack?
jetpack_module_required	(string)	The slug of the module that is required to be activated in Jetpack for this service integration to work, if any.
warnings	(array)	Any issues this type of connection may be experencing

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code	Error Identifier	Error Message
404	not_found	The service provided does not exist

Example

curl 'https://public-api.wordpress.com/rest/v1.1/meta/external-services/facebook'

<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1.1/meta/external-services/facebook',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "ID": "facebook",
    "label": "Facebook",
    "type": "publicize",
    "description": "Publish your posts to your Facebook timeline or page.",
    "genericon": {
        "class": "facebook-alt",
        "unicode": "\\f203"
    },
    "icon": "http:\/\/i.wordpress.com\/wp-content\/admin-plugins\/publicize\/assets\/publicize-fb-2x.png",
    "connect_URL": "https:\/\/public-api.wordpress.com\/connect\/?action=request&kr_nonce=bd1d3b3bd8&nonce=de788f17f2&for=connect&service=facebook&kr_blog_nonce=8f1a9b3ff3&magic=keyring&blog=2916284",
    "multiple_external_user_ID_support": true,
    "external_users_only": true,
    "jetpack_support": true,
    "jetpack_module_required": "publicize"
}