Get information about a single external service that WordPress.com or Jetpack sites can integrate with via keyring.
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
This endpoint does not return any errors.