Connect API Endpoints

Before You Begin

In order to access endpoints you will need to fetch a token using OAuth 2. Head over to Getting Started for more information.

Endpoints

Map List

This function allows you retrieve a list of maps on a user's account.

URL

https://www.scribblemaps.com/api/user/maps/

Request Body

Request must get GET over HTTPS and include an authorization bearer header with the user token.

Respose

Response is in application/json

            
{
    mapList: [
        {
        mapCode: "BvE7Ux9iRC",
        title: "A Test Map",
        description: "OAuth Test Map",
        created: "2018-10-01T18:51:02.67",
        lastModified: "0001-01-01T00:00:00",
        isSecure: false,
        isPublic: false,
        thumbUrl: "//scribblemaps.com/api/maps/images/BvE7Ux9iRC_thumb_400x400.jpg",
        shareUrl: "//scribblemaps.com/maps/view/aaaa/BvE7Ux9iRC",
        geoJsonUrl: "//scribblemaps.com/api/maps/BvE7Ux9iRC/geojson",
        kmlUrl: "//scribblemaps.com/api/maps/BvE7Ux9iRC/kml",
        smJsonUrl: "//scribblemaps.com/api/maps/BvE7Ux9iRC/smjson",
        csvUrl: "//scribblemaps.com/api/maps/BvE7Ux9iRC/csv",
        gpxUrl: "//scribblemaps.com/api/maps/BvE7Ux9iRC/gpx",
        dxfUrl: "//scribblemaps.com/api/maps/BvE7Ux9iRC/dxf",
        shpUrl: "//scribblemaps.com/api/maps/BvE7Ux9iRC/shp"
        },
        ...
    ]
}

Map Data

This endpoint lets you fetch map data for the map in a selected format.

URL

https://www.scribblemaps.com/api/maps/{MAPCODE}/{FORMAT}

Request Parameters

{MAPCODE}: The mapcode for the user map being requested.
{FORMAT}: The format map data should be returned as for the map. Formats include geojson, kml, csv, smjson, shp, dxf

Respose

Response type will depend on the format requested.

SHP Files return as a zip file.