Skip to content

OffiServ API

by on April 14, 2011

We would like to announce the availability of OffiServ API for developers. It allows deeper integration of your current IT solutions with OffiServ.


The OffiServ API is an open API that allows access to the service using programming interface. Developers can acquire data from the service, manipulate it and also invoke actions. OffiServ API is based on REST model and uses JSON for data formats.


Access to the API is available only to authenticated users. Authentication employs form + cookie approach. To make your data safe all requests sent to the service must use HTTPS protocol.

Sign in procedure

The URI to sign in form is /data/login. To get a cookie required for subsequent operations you have to send POST with JSON body containing proper email and password fields. Returned cookie should be included in following requests to the service.

Here is a usage example using cURL, a tool for submitting HTTP requests using command line (available for Windows, Linux and MacOS X):

$ curl -v -X POST -c cookies.txt -d '{"email": "", "password": "123"}'

Service resources roots

Application resources in OffiServ are put in hierarchical structure. There are defined several special URIs that are roots of the application resources structure:

/data/companies/my – GET method returns the organization of currently signed in user
/data/users/me – GET method returns currently signed in user

$ curl -b cookies.txt -c cookies.txt -v -X GET

$ curl -b cookies.txt -c cookies.txt -v -X GET


More details about the API can be found on The OffiServ API page. It provides URIs of the services, formats of data and examples. We hope that it will improve integration of your organization with OffiServ service.


From → New features

Leave a Comment

Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )


Connecting to %s

%d bloggers like this: