uebermaps API v2

Hello developer. This is the uebermaps JSON REST API v2.
uebermaps is a platform for everyone to create and share maps with your favorite spots.
uebermaps are interactive maps that enable people to collect interesting places, collaborate, upload photos and share your public or private maps with your friends and family. If you use uebermaps for your mapping community, as a tour guide for friends or as your unlimited geo storage is up to you. Get started right now.
Every registered uebermaps user can use this API. All API endpoints are only accessible via https. The current API version is v2. For instance: grab a map by accessing the following url:

https://uebermaps.com/api/v2/maps/MAP_ID?auth_token=AUTH_TOKEN

Important note

For your application, you should have each user go through an authentication and authorization flow in order to receive a valid auth_token.

Limits

Be nice. If you're sending too many requests too quickly, we'll send back a 503 error code (server unavailable). Each user is limited to 5000 requests per hour per auth_token. Whenever possible authenticate users so that limits dont´t count on your own auth_token.

Structure

JSON response

The meta key contains a code key and in case an error occured it contains additional information about the error. For index requests the meta key contains pagination information. The data key is where you find the data you requested. This can be a dictionary or an array. Each API request receives a JSON response. The basic structure of a response looks like:

{
    "data" : {
        "id" : 63921,
        "name" : "Bill Hicks",
        "screen_name" : "billhicks",
        "url" : "http://www.billhicks.com",
        "location" : "Little Rock, Arkansas",
        "profile_picture" : null,
        "picture_url" : null,
        "header_picture" : null,
        "about" : null,
        "counts" : {
            "maps" : 12
        }
    },
    "meta" : {
        "code" : 200
    }
}

Pagination

page (optional) Specifies the page of results to retrieve.
count (optional) The number of potential results to retrieve per page. This value has a maximum of 50 for most resources.
max_id/min_id To use max_id correctly, an application’s first request to a endpoint should only specify a count. When processing this and subsequent responses, keep track of the lowest ID received. This ID should be passed as the value of the max_id parameter for the next request, which will only return objects with IDs lower than or equal to the value of the max_id parameter.

Media upload

The image passed should be base64 encoded.

Authentication

Authentication is handled by an authentication token. Authentication tokens may expire at any time in the future.

Receiving an auth_token

To receive an auth_token with HTTP Basic Authentication you have to make a get request to:

curl -v -u john.doe@example.com:PASSWORD -X GET https://uebermaps.com/api/v2/authentication

To receive an auth_token with url parameters user[email] and user[password] you have to make a get request to:

curl -v -X GET https://uebermaps.com/api/v2/authentication?user%5Bemail%5D=john.doe%40example.com&user%5Bpassword%5D=PASSWORD

Your response will look like this:

{
    "data" : {
        "id" : 63921,
        "name" : "Bill Hicks",
        "screen_name" : "billhicks",
        "url" : "http://www.billhicks.com",
        "location" : "Little Rock, Arkansas",
        "profile_picture" : null,
        "picture_url" : null,
        "header_picture" : null,
        "about" : null,
        "counts" : {
            "maps" : 12
        },
        "time_zone" : null,
        "language" : null,
        "auth_token" : "VAxoQv9awynTek6K3p7L"
    },
    "meta" : {
        "code" : 200
    }
}

Keep the received auth_token securely for later requests. On subsequent requests simply pass the auth_token as part of your data and you will be automatically authenticated.

You can pass authentication tokens as part of the url but authentication tokens are best send in the request header

curl -v -X GET -H 'X-AUTH-TOKEN': 'VAxoQv9awynTek6K3p7L' https://uebermaps.com/api/v2/maps/MAP_ID
curl -v -X GET https://uebermaps.com/api/v2/maps/MAP_ID?auth_token=VAxoQv9awynTek6K3p7L