The GeoOp API allows developers to integrate GeoOp functionality into their mobile, network or desktop applications.

Overview

The API implements the REST architecture and provides an easy and intuitive way of communication with the GeoOp system via the HTTP protocol. By sending GET, POST, PATCH, and DELETE requests to various API endpoints it is possible to manipulate the corresponding data containers called items.

The API receives requests and responds in widely supported JSON format thus allowing the developers to write GeoOp-powered applications in almost any major programming language (such as Java, C#, C/C++, PHP, Perl, Python, Ruby, etc.) and for all major platforms, including Windows, Mac OS X, Linux, iPhone, Android and Windows Phone.

Examples

Here's a couple of examples to demonstrate how easy it is to use the API.

If we want to get a list of all registered users we simply send a GET request to the /users endpoint:

GET /users HTTP/1.1
Host: api.geoop.com
Authorization: Bearer oJ_7Hj.f-F3f.kL
X-Version: 1.0

And to create a new job we send a POST request with a JSON object containing job data to the /jobs endpoint:

POST /jobs HTTP/1.1
Host: api.geoop.com
Authorization: Bearer oJ_7Hj.f-F3f.kL
Content-Type: application/json
X-Version: 1.0

{
    "jobs": [
        {
            "client": {"id": 318},
            "status": {"id": 1},
            "account": {"id": 22},
            "title": "Sample Job"
        }
    ]
}

Click here to see more detailed examples.

Getting Started

To start using the API you need to first register a developer account on this portal and then add a new application, which will be assigned a unique identifier and a secret (password).

With the application identifier and secret you can request access tokens from our Authentication Server and then use them to make API requests. In fact, you can generate sample tokens right on your account page and test the API requests in the API Demo section.

An of course on this portal you will find many articles that describe how exactly the API works, what kind of data you can manipulate and how to do that.

Limitations

Please be aware that currently the API is still being under extensive development and although we do our best to ensure that the production builds are stable, it is nonetheless possible that some bugs may appear here and there.

We will also be continuously adding new and improving existing features. Some features that are not yet implemented but are planned to be added to the API in the near future are labelled Not Implemented.