SIOC API

Basic Information 

The SindiceSIOC API is a custom API built on top of the public Sindice API and serves as a gateway to the SIOC-o-Sphere through a set of discovery and search services.
The current version enables the verification of the presence of a user or a link on the SIOC-o-Sphere (indexed within Sindice).

Access

Input 

The API is accessible through a REST web service (available at http://api.sindice.com/sioc/v1/metadata) with the operation type and options passed through a set of HTTP GET parameters:
The first parameter (op) always indicates the operation type, the rest of the parameters (hash or link) are additional and depend on the respective service (see below for details).
Example: http://api.sindice.com/sioc/v1/metadata?op=ua&hash=2sg4g4duiiu2knsdsadn324

Output 

Regardless of the called API service, the output data is always encoded in JSON with the JSON object schema depending on the particular service (see below for details).

Services

User Activity

  • User Status (us)

    Description: Checks whether a user has any activity on the SIOC-o-Sphere. Based on user sha1 email checksum (foaf:mbox_sha1sum).

    Parameters: op = 'us', hash = sha1 checksum of the user email address

    Query example: http://api.sindice.com/sioc/v1/metadata?op=us&hash=2sg4g4duiiu2knsdsadn324

    Output:

    Schema:

{
    "status": {"type":"number"}
}

    Example: 

{
   status: 1
}
  • Get User Activity (ua)

    Description: Fetches the description of documents that contain the posts or comments made by the user with a given sha1 email checksum (foaf:mbox_sha1sum).

    Parameters: op = 'ua', hash = sha1 checksum of the user email address

    Query example: http://api.sindice.com/sioc/v1/metadata?op=ua&hash=2sg4g4duiiu2knsdsadn324
    Output:

    Schema:

{
    "username": {"type":"string"},
    "photo": {"type":"string"},
    "posts": [
	"label": {"type":"string"},
	"location": {"type":"string"},
	"createDate": {"type":"string"},
	"createTime": {"type":"string"}

    ],
    "comments": [
	"content": {"type":"string"},
	"location": {"type":"string"},
	"parentPostUrl": {"type":"string"},
	"parentPostName": {"type":"string"},
	"createDate": {"type":"string"},
 	"createTime": {"type":"string"},
 	"label": {"type":"string"}

    ],
    "topics": [
	"label": {"type":"string"},
	"location": {"type":"string"}
    ]
}

    Example: 

{
  username: "admin",
  photo: "",
  posts:[
    {
      label: "Sindice in use",
      location: "http://blog.sindice.com/?p=8",
      createDate: "2008-02-20",
      createTime: "10:08:42"
    },
    {
      label: "Sindice @ 20+ Millions and Openings",
      location: "http://blog.sindice.com/?p=7",
      createDate: "2007-11-22",
      createTime: "18:14:23"
    }
  ],
comments:[
    {
      content: "Hello, quite a nice feature",
      location: "Bestselling book of Foo by A.N. Other",
      parentPostUrl: "http://blog.sindice.com/?p=7",
      parentPostName: "Sindice @ 20+ Millions and Openings",
      createDate: "2008-02-12",
      createTime: "12:33:11",
      label: "Hello, quite a nice feature"
    }
  ],
topics:[
    {
      label: "Announcements",
      location: "http://blog.sindice.com/?cat=3"
    },
    {
      label: "Sindice",
      location: "http://blog.sindice.com/?cat=4"
    }
  ]
}

Link Activity

  • Link status (ls)

    Description: Checks whether the link is mentioned anywhere on the SIOC-o-Sphere. The result of this process is a boolean that indicates the status of the link.

    Parameters: op = 'ls', link = URL address with properly escaped characters 

    Query example: http://api.sindice.com/sioc/v1/metadata?op=ls&link=http://www.sindice.com
    Output: 

    Schema:

{
    "status": {"type":"number"}
}

    Example:  

{
   status: 0
}



  • Get Link occurrence (lo)

    Description: Queries the SIOC-o-Sphere for documents containing the given URL and returns the document list and their descriptions. (It uses the Sindice URI search to select the documents containing the link.)

    Parameters: op = 'lo', link = URL address with properly escaped characters

    Query example: http://api.sindice.com/sioc/v1/metadata?op=lo&link=http://www.sindice.com
    Output: 

    Schema: 

{
    "username": {"type":"string"},
    "photo": {"type":"string"},
    "posts": [
	"label": {"type":"string"},
	"location": {"type":"string"},
	"createDate": {"type":"string"},
	"createTime": {"type":"string"}

    ],
    "comments": [
	"content": {"type":"string"},
	"location": {"type":"string"},
	"parentPostUrl": {"type":"string"},
	"parentPostName": {"type":"string"},
	"createDate": {"type":"string"},
 	"createTime": {"type":"string"},
 	"label": {"type":"string"}

    ],
    "topics": [
	"label": {"type":"string"},
	"location": {"type":"string"}
    ]
}

    Example:  

{
  username: "",
  photo: "",
  posts:[
    {
      label: "Sindice in use",
      location: "http://blog.sindice.com/?p=8",
      createDate: "2008-02-20",
      createTime: "10:08:42"
    },
    {
      label: "Sindice @ 20+ Millions and Openings",
      location: "http://blog.sindice.com/?p=7",
      createDate: "2007-11-22",
      createTime: "18:14:23"
    }
  ],
comments:[
    {
      content: "Hello, quite a nice feature",
      location: "Bestselling book of Foo by A.N. Other",
      parentPostUrl: "http://blog.sindice.com/?p=7",
      parentPostName: "Sindice @ 20+ Millions and Openings",
      createDate: "2008-02-12",
      createTime: "12:33:11",
      label: "Hello, quite a nice feature"
    }
  ],
topics:[
    {
      label: "Announcements",
      location: "http://blog.sindice.com/?cat=3"
    },
    {
      label: "Sindice",
      location: "http://blog.sindice.com/?cat=4"
    }
  ]
}