Public API – GET Applications

The GET applications endpoint returns application details for a customer account.

URL to call

https://api.bluedotinnovation.com/1/applications?customerApiKey=1a64a14c-5bc8-44bb-ab9a-076c4518b407

Parameters

Name
Required
Data Type
Description
Format
customerApiKey String API key for customer (rather than the app).
apiKey String A specific API key.

GET all applications

Using only the Customer API Key to retrieve application details will return a list of applications as a JSON array for a given customer.

https://api.bluedotinnovation.com/1/applications?customerApiKey=1a64a14c-5bc8-44bb-ab9a-076c4518b407

Example: JSON response for GET All applications

[
    {
        "_id": "e70e487c-c15d-4764-a1c5-92b10726a63a",
        "name": "University Campus Application",
        "packageName": "com.bluedotinnovation.campusapp",
        "nextRuleUpdateIntervalFormatted": "00:30",
        "apiKey": "1a64a14c-5bc8-44bb-ab9a-076c4518b407",
        "webhook": {
            "url":"https://api.campusapp.com/webhook/checkinreceiver",
            "enabled":true,
            "securityTokenKey":"authToken",
            "secuityTokenValue":"f2f7a58c-f0d5-498c-9bad-acbc89923dc5"
        }
    },
    {
        "_id": "91b57ffe-2661-4571-871a-10d65902a0bf",
        "name": "Coffee Shop Application",
        "packageName": "com.bluedotinnovation.coffeeshopapp",
        "nextRuleUpdateIntervalFormatted": "01:00",
        "apiKey": "bc8904a0-2c20-11e5-8e98-06cc00ebc8ad"   
    },
    {
        "_id": "71a6cc46-3646-496a-8fbd-40923f3397eb",
        "name": "Daily Travel Application",
        "packageName": "com.bluedotinnovation.travelapp",
        "nextRuleUpdateIntervalFormatted": "06:00",
        "apiKey": "c335f0e2-62b7-46df-a173-b4a8d7c70c65",
        "webhook": {
            "url": "https://api.travelapp.com/webhook/checkinreceiver",
            "enabled": false,
            "securityTokenKey": "apiKey",
            "secuityTokenValue": "e4d2697bc8cc4df98ab6a88f0fd56ec3"
        }
    }
]

GET a specific application

Using the Customer API Key & the API Key of the application to retrieve details of a specific application will return a application details as a JSON object for a given customer’s application.
https://api.bluedotinnovation.com/1/applications?customerApiKey=1a64a14c-5bc8-44bb-ab9a-076c4518b407&apiKey=1a64a14c-5bc8-44bb-ab9a-076c4518b407

Example: JSON response for GET specific application

{
    "_id": "e70e487c-c15d-4764-a1c5-92b10726a63a",
    "name": "University Campus Application",
    "packageName": "com.bluedotinnovation.campusapp",
    "nextRuleUpdateIntervalFormatted": "00:30",
    "apiKey": "1a64a14c-5bc8-44bb-ab9a-076c4518b407",
    "webhook": {
        "url":"https://api.campusapp.com/webhook/checkinreceiver",
        "enabled":true,
        "securityTokenKey":"authToken",
        "secuityTokenValue":"f2f7a58c-f0d5-498c-9bad-acbc89923dc5"
    }
}

Source code examples

Created by Bluedot DevOps on March 3, 2018

Start the discussion