Findsi API documentation
Findsi API documentation
| Method | GET |
| Rel | findsi:actor |
| Description | Returns a single Actor |
None
A successful response (HTTP 200) will be a HAL document, containing the following:
Besides the default _self and curies links, the following links will be included:
| actors | Returns a paged list of Actors the requesting API consumer has logged activities for. |
| actor-similars | Returns a list of Actors that are deemed similar to the given Actor. |
| actor-targets | Returns a paged list of Targets, the given Actor has interacted with. |
None
| Id | String | Id of the Actor, as it was specified by the API consumer in the activity logs. |
| Classification | String | Id of the Actor, as it was specified by the API consumer in the activity logs. |
The API may respond with one of the following errors:
| 401 | Unauthorized | The Authorization header might be missing or malformed. Alternatively you may have provided an invalid API key. |
A basic request would look something like:
GET /actors/... HTTP/1.1
Host: api.findsi.com
Accept: application/hal+json
Authorization: findsi_api_key apikey="..."
Content-Type: application/json
If all went well, your response will look something like this:
Cache-Control no-cache
Content-Length 623
Content-Type application/hal+json; charset=utf-8
Date Thu, 11 Sep 2014 15:05:02 GMT
Expires -1
Pragma no-cache
{
"Id": "456",
"Classification": "user",
"_links": {
"curies": {
"href": "http://www.findsi.com/docs/link-relations/{rel}",
"templated": true,
"name": "findsi"
},
"findsi:actors": {
"href": "/actors"
},
"findsi:actor-targets": {
"href": "/actors/.../targets"
},
"findsi:actor-similars": {
"href": "/actors/.../similars"
},
"self": {
"href": "/actors/..."
}
}
}