Learn more:

• Mobile Application Performance SDK

• Download this API’s RAML and JSON schema descriptors.

Overview

To control caching and increase performance, the Mobile Application Performance (MAP) software development kit (SDK) lets you pre-position frequently downloaded content on a mobile device, such as images and videos. Once this content is on the device, it’s ready whenever the application user requests it.

To pre-position content on a mobile device, you need to associate groups of users with appropriate content URLs. This process is known as ingesting content. The MAP Ingest API offers a programmatic interface that lets you segment application users into different groups and associate URLs with those segments. This gives you the flexibility to push suitable content to mobile devices at the appropriate time.

For example, you might call one user segment Bargain Shopper that loads new images from your sales on a daily basis.

Together, the MAP SDK and the MAP Ingest API give you the tools to build, expedite, and manage the best possible mobile experience for your Android and iOS users.

For details on the MAP SDK, see Get Started with the Mobile App Performance SDK.

Get started

To configure this API for the first time:

• Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To enable this API, choose the API service named MAP Ingest API and set the access level to READ-WRITE.

• Before running these operations, contact your Akamai representative to enable the MAP SDK for your account.

Resources

This section describes the API’s workflow and provides details on how to interact with each operation.

API summary

Download the RAML descriptors for this API.

List applications

Returns a list of MAP SDK applications enabled on your account.

[
    {
        "appId": 5000,
        "appName": "MAP-App1",
        "sdkKey": "MAP-App1-apikey",
        "activeDevices": 100
    },
    {
        "appId": 5001,
        "appName": "MAP-App2",
        "sdkKey": "MAP-App2-apikey",
        "activeDevices": 10
    }
]

Get an application

Returns a specific MAP SDK application enabled on your account.

{
    "appId": 5001,
    "appName": "MAP-App1",
    "sdkKey": "MAP-App1-apikey",
    "activeDevices": 100
}

List segments

Returns the existing content segments for a MAP SDK application.

[
    {
        "segment": "map-segment-1",
        "modified": "2019-10-22T02:12:54966Z",
        "created": "2019-09-01T02:12:54966Z",
        "urlsNumber": 2
    },
    {
        "segment": "map-segment-2",
        "modified": "2019-10-22T02:12:54966Z",
        "created": "2019-09-01T02:12:54966Z",
        "urlsNumber": 2
    }
]

Create new segments

Create new content segments for a MAP SDK application.

[
    {
        "segment": "map-segment-1",
        "urls": [
            {
                "url": "https://www.akamai.com/1"
            },
            {
                "url": "https://www.akamai.com/2"
            }
        ]
    },
    {
        "segment": "map-segment-2",
        "urls": [
            {
                "url": "https://www.akamai.com/10"
            },
            {
                "url": "https://www.akamai.com/11"
            }
        ]
    }
]

Update segments

Modify the URL entries for a MAP SDK application’s existing content segments.

[
    {
        "segment": "map-segment-1",
        "urls": [
            {
                "url": "https://www.akamai.com/1"
            },
            {
                "url": "https://www.akamai.com/2"
            }
        ]
    },
    {
        "segment": "map-segment-2",
        "urls": [
            {
                "url": "https://www.akamai.com/10"
            },
            {
                "url": "https://www.akamai.com/11"
            }
        ]
    }
]

Remove segments

Removes existing content segments from a MAP SDK application.

List URLs

Returns a list of URLs for a MAP SDK application’s content segment.

[
    {
        "url": "https://www.akamai.com/1",
        "added": "2019-09-01T02:12:54966Z"
    },
    {
        "url": "https://www.akamai.com/2",
        "added": "2019-09-01T02:12:54966Z"
    }
]

Data

This section provides details for each type of data object the API exchanges.

Download the JSON schemas for this API.

Application

Provides information about a MAP SDK application enabled on your account.

Download schema: application.json

Sample GET response:

[
    {
        "appId": 5000,
        "appName": "MAP-App1",
        "sdkKey": "MAP-App1-apikey",
        "activeDevices": 100
    },
    {
        "appId": 5001,
        "appName": "MAP-App2",
        "sdkKey": "MAP-App2-apikey",
        "activeDevices": 10
    }
]

Application members

Segment

Provides information about an application’s content segment.

Download schema: segment.json

Sample GET response:

[
    {
        "segment": "map-segment-1",
        "modified": "2019-10-22T02:12:54966Z",
        "created": "2019-09-01T02:12:54966Z",
        "urlsNumber": 2
    }
]

Segment members

Errors

This section provides details on the data object that reflects the API’s common response to error cases. It also lists the API’s range of response status codes for both error and success cases.

Error responses

This API responds with JSON objects that adhere to the HTTP Problem Details standard.

This example shows an error response to a request for a MAP SDK application that’s not available on your account. Refer to the incidentId when communicating with Akamai customer support.

HTTP/1.1 404 Not Found
X-Application-Context: Mobile App Performance SDK:sqa:23848
Vary: Accept
Content-Type: application/problem+json
Content-Length: 259
X-Trace-Id: a0485d94f3b1013a
Date: Wed, 02 Oct 2019 19:00:01 GMT
Connection: close

{
   "details":[
      {
         "field":null,
         "code":"#IE:ANF",
         "message":"Cannot find given application",
         "data":null
      }
   ],
   "code":"resource.not.found",
   "title":"Resource Not Found",
   "incidentId":"711a9466-e513-4c70-8315-18ac84ed3e08",
   "stackTrace":null,
   "resolution":null,
   "helpUrl":null
}

HTTP status codes

This section lists the full range of response codes the API may generate.

Last modified: 11/6/2019