Logo

API Documentation

Welcome Eviscape Developer Central

Evis are rich messages (which can contain XML "fields" and file attachments) that flow around the network Edges to other Nodes.
Our network allows Nodes to "broadcast" Evis to any Node that cares to "listen"
Note: One Evis, Many Evis
In due course we will add support for other elements in our network e.g. Filters.

Response Formats

xml, json, yaml, csv,

Request Format

http://www.eviscape.com/api/1.0 ...
.../rest/?method={METHOD_NAME}&format={FORMAT}¶m1={PARAM1}
Test: XML  JSON  CSV  YAML

Request Format with Authentication

http://www.eviscape.com/api/1.0 ...
.../rest/?method={METHOD_NAME}&format={FORMAT}&param1={PARAM1}&oauth_token={ACCESS_TOKEN}&oauth_consumer_key={API_KEY}&oauth_signature_method={SIGNATURE_METHOD}&oauth_signature={SIGNATURE}
Read authentication docs

Json Callback

jsoncallback=YOURCALLBACK(return json with yourcallback) or jsoncallback=?(return json with empty callback) or nojsoncallback=1(return pure json)

Pagination

By default we are injecting maximum of 1000 records per call, amount can be lowered but cannot be higher than 1000.
We support following parameters with every api method call.
page={page_number}
per_page={per_page_objects}

API Wrappers (Community)

We recommend you you to checkout following API Wrappers:

API Method List

We support following API Method in this version of API

API Methods

test.echo

Prints hello world
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information



Try this method in API Console - Top

nodes.unfollow

Unfollow a target node
This method requires authentication with read perms.

Required Parameters:
target_nod_id(target_nod_id of integer type is required)
nod_id(nod_id of integer type is required)


Try this method in API Console - Top

nodes.speakers

Get speakers of a node
This method requires authentication with read perms.

Required Parameters:
nod_id(nod_id of integer type is required)

Optional Parameters:
page(page of integer type and of range 1-pages)
per_page(per_page of integer type and of range 0-1000)

Try this method in API Console - Top

nodes.search

Search public nodes based on query
This method does NOT require authentication.

Required Parameters:
q(q of string type is required)


Try this method in API Console - Top

nodes.member

Get all nodes of member
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information

Required Parameters:
mem_name(mem_name of string type is required)

Optional Parameters:
perms(perms of string type. possible values: read,write)

Try this method in API Console - Top

nodes.listeners

Get the listeners of a Node
This method requires authentication with read perms.

Required Parameters:
nod_id(nod_id of integer type is required)

Optional Parameters:
page(page of integer type and of range 1-pages)
per_page(per_page of integer type and of range 0-1000)

Try this method in API Console - Top

nodes.get

Get Nodes of a member which he/she created
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information

Required Parameters:
mem_name(mem_name of string type is required)

Optional Parameters:
page(page of integer type and of range 1-pages)
per_page(per_page of integer type and of range 0-1000)

Try this method in API Console - Top

nodes.follow

Follow a target node
This method requires authentication with read perms.

Required Parameters:
target_nod_id(target_nod_id of integer type is required)
nod_id(nod_id of integer type is required)


Try this method in API Console - Top

nodes.community

Get community of a node: i.e. the Members, Listeners and Speakers of the node in question
This method does NOT require authentication.

Required Parameters:
nod_id(nod_id of integer type is required)

Optional Parameters:
page(page of integer type and of range 1-pages)
per_page(per_page of integer type and of range 0-1000)

Try this method in API Console - Top

node.get

Get Node details with the permissions of the authorized user
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information

Required Parameters:
nod_id(nod_id of integer type is required)


Try this method in API Console - Top

members.search

Search for Eviscape members. You can provide a valid tsearch2 query. Otherwise we will perform a tsearch2 AND search on the words. The data that is available for searching depends on each member's privacy settings: If mem_strict is True, mem_pen_name will be Anon or None so only the members Primary Node name will be available for the search. If mem_strict is False, mem_name, mem_full_name, mem_email, nod_name_primary are available for searching.
This method does NOT require authentication.

Required Parameters:
q(q of string type is required)


Try this method in API Console - Top

member.token

Get member who approved provided oauth token
This method requires authentication with read perms.

Required Parameters:
mem_oauth_token(mem_oauth_token of string type is required)


Try this method in API Console - Top

file.upload

Upload file to node or pin it to evis. Max size 2 MB, files limit per node 1000 files parameter "File" should be sent via POST (multipart/form-data)
This method requires authentication with write perms. Additional Eviscape Permission Required.

Required Parameters:
mem_id(mem_id of integer type is required)
nod_id(nod_id of integer type is required, where this file should go)

Optional Parameters:
evi_id(evi_id if you want to attach this file to evis)

Try this method in API Console - Top

file.status

Get status quota of node's file manager
This method requires authentication with read perms. Additional Eviscape Permission Required.

Required Parameters:
mem_id(mem_id of integer type is required)
nod_id(nod_id of integer type is required, where this file should go)


Try this method in API Console - Top

evis.timeline

Get node's timeline (recent sent and received Evis) maximum of last 1000 posts
This method requires authentication with read perms. Additional Eviscape Permission Required.

Required Parameters:
nod_id(nod_id of integer type is required)
mem_id(mem_id of integer type is required)


Try this method in API Console - Top

evis.sent

Get node's sent or published evis
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information

Required Parameters:
nod_id(nod_id of integer type is required)

Optional Parameters:
page(page of integer type and of range 1-pages)
per_page(per_page of integer type and of range 0-1000)

Try this method in API Console - Top

evis.search

Search evis on eviscape. e.g q=hello (world OR germany) .
This method does NOT require authentication.

Required Parameters:
q(A query of string type is required e.g q=hello+world)


Try this method in API Console - Top

evis.received

Get node's inbox or received evis
This method requires authentication with read perms.

Required Parameters:
nod_id(nod_id of integer type is required)
mem_id(mem_id of integer type is required)

Optional Parameters:
page(page of integer type and of range 1-pages)
per_page(per_page of integer type and of range 0-1000)

Try this method in API Console - Top

evis.post

Posts an evis to a node
This method requires authentication with write perms. Additional Eviscape Permission Required.

Required Parameters:
evi_subject(evis subject of string type is required)
evi_body(evis body of string type is required)
mem_id(mem_id of integer type is required)
nod_id(nod_id of integer type is required, to whom you want to write evis)

Optional Parameters:
evi_is_draft(evis_is_draft is optional 0 or 1 is expected)
evi_type(evi_type tag is optional)
evi_tags(evi_tags is optional)

Try this method in API Console - Top

evis.latest

Get last 100 evis from latest public evis pool
This method does NOT require authentication.


Optional Parameters:
page(page of integer type and of range 0-total page)
per_page(per_page of integer type and of range 0-100)

Try this method in API Console - Top

evis.get_files

Get files of an evis (a post that flows around the network.)
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information Additional Eviscape Permission Required.

Required Parameters:
nod_id(nod_id of integer type is required)
evi_id(evi_id of integer type is required)


Try this method in API Console - Top

evis.get

Get details on an evis (a post that flows around the network.)
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information Additional Eviscape Permission Required.

Required Parameters:
nod_id(nod_id of integer type is required)
evi_id(evi_id of integer type is required)


Try this method in API Console - Top

comments.get

Get comments for an evis, Evis can be public or private.
This method optionally requires authentication with read perms. Oauth parameters are only required to access private information without oauth parameters you are allowed to access public information Additional Eviscape Permission Required.

Required Parameters:
nod_id(nod_id of integer type is required)
evi_id(evi_id of integer type is required)


Try this method in API Console - Top

comment.post

Posts comment to an evis
This method requires authentication with write perms. Additional Eviscape Permission Required.

Required Parameters:
comment(comment body of string type is required)
evi_id(evi_id of integer type is required)
mem_id(mem_id of integer type is required)
nod_id(nod_id of integer type is required)


Try this method in API Console - Top
API Error codes:
96 : Invalid Signature
97 : Invalid Signature Method
98 : Invalid auth token for this operation
99 : Insufficient permissions
100 : Invalid API Key
101 : Insufficient eviscape permissions
102 : Validation Error
104 : Object not found
105 : Quota Exceed Error
106 : Media over size Error
107 : Media format Error
108 : Account email have to be verified for this method
110 : EQL Error
111 : Invalid Formatter
112 : Method xxx not found
113 : Missing Parameter
114 : Invalid Type
115 : Internal Error

This document is auto-generated by a Eviscape ApiDocs