Proofile

Proofile API

Retrieve Data

Please read the API introduction for general remarks on how to access users or how to specify the return types. Proofile uses standard HTTP GET requests for retrieving data. OAuth signed requests are optional, most API calls will work without, but only returning publicly available data.

User

Availability

http://api.proofile.org/userid/{userid}/available

Checks if the user exists. The user will only be found if the appropriate "data export" value has been set to at least "searchable". Don't forget to replace the {userid} with the correct value. Returns the user id if the user was found, otherwise returns 0.

default return type: CSV
available return type: CSV, JSON, XML, PHP, DUMP

Profile

http://api.proofile.org/userid/{userid}/profile

Returns the profile, containing username, profile_fields, accounts, feeds and foaf connections.

default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP

Friends

http://api.proofile.org/userid/{userid}/friends

Returns a list of friend IDs and the XFN annotation.

default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP

Avatar

Availability

http://api.proofile.org/userid/{userid}/avatar/available

Returns the user id if the user was found and has an avatar that is exported, otherwise returns 0.

default return type: CSV
available return type: CSV, JSON, XML, PHP, DUMP

Preferred Size

http://api.proofile.org/userid/{userid}/avatar/avatar.png

Returns the users avatar in his preferred avatar size. If no image was found, a 50x50 pixel sized proofile.org logo will be returned.

Custom Size

http://api.proofile.org/userid/{userid}/avatar/size/{size}.png

Returns the users avatar in the specified size. Replace {size}.png with the requested dimension in pixels. "120.png" for example would return the users avatar with 120 pixels width and 120 pixels height.

Available sizes: between 16 and 256 pixels

Search

By OpenID

http://api.proofile.org/search/openid?query={q}&page={p}&entriesperpage={e}

Searches the database for users (prefix-) matching an OpenID, {q} is an url-encoded string. Only users will be found who have set data export to at least searchable for their respective OpenIDs. Specifying a page number {p} is optional, if no value is entered, the first page with index 0, will be returned. Entries per page {e} may be an integer value between 1 and 100, defaulting to 10, if not specified.

default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP, HTML

By Profile Field

http://api.proofile.org/search/profile?query={q}&page={p}&entriesperpage={e}

Searches the database for users (prefix-) matching a profile field, {q} is a string. Only users will be found who have set data export to at least searchable for their respective profile fields. Specifying a page number {p} is optional, if no value is entered, the first page with index 0, will be returned. Entries per page {e} may be an integer value between 1 and 100, defaulting to 10, if not specified.

default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP, HTML

General

Ping

http://api.proofile.org/ping

Use this command to test your OAuth signatures, expiration dates and access rights for OAuth calls.

A sample JSON return value for an OAuth signed call could look like follows. The user_id annotates the user ID that granted access to the resources in access_rights. This particular OAuth key has not expired and no expiry date is set ("expiration_timestamp":"0"). If expiration_timestamp is "1", then the user has manually revoked the key, ohterwise this value will be a UNIX timestamp of the expiration time.

{
"signed":true,
"user_id":"55",
"access_right":["write_connection","write_profile"],
"expired":false,
"expiration_timestamp":"0"
}

default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP

FOAF Parser

http://api.proofile.org/parse_foaf?url={url}

Parses the given FOAF url and returns a hierarchy in your preferred serialization format. See this example, url-encoding is optional.

default return type: JSON
available return type: CSV, JSON, XML, PHP, DUMP