API Documentation

Configs

API related to creating, modifying and viewing configs.

Config Collection

Create a config

/config

Create a new config. The config will be initialized but will not be added to the build queue until it meets all the requirements, both resources and the settings.

RequestShowHide

Headers

Content-Type: application/json

Body

{
    "name": "tablika",
    "platform": "ios"
}

Response 201ShowHide
Headers
```
Location: /api/v1/config/tablika
```

List configs

GET

/config

Response 200ShowHide
Body
```
["cail","tablika"]
```

Config

View a config

GET

/config/{name}

Parameters
name
string (required)
Name of the config

Response 200ShowHide

Body

{
  "settings": {
    "app": {
      "urlName": "tablika",
      "urlScheme": "tablika",
      "name": "Tablika",
      "bundleId": "com.tablika"
    },
    "config": {
      "url": {
        "termsOfUse": "http://www.tablika.com/terms-of-use",
        "privacyPolicy": "http://www.tablika.com/privacy-policy",
        "help": "http://tablika.com/help/",
        "about": "http://tablika.com/about",
        "portal": "https://portal.tablika.com",
        "production": "tablika.com"
      },
      "api": {
        "url": "https://portal.tablika.com/api",
        "brand": "main"
      },
      "features": {
        "anonymousLogin": "Yes",
        "publicApps": "Yes"
      },
      "hockeyApp": {
        "appId": "c3415a8f964531b7548fbdfa71e2d078"
      },
      "googleAnalytics": {
        "trackingId": "UA-62668734-1"
      },
      "appearance": {
        "primaryColor": "163,36,42"
      },
      "copyright": "Tablika © 2015",
      "isProduction": "Yes",
      "introYouTubeVideoId": "9Gs7iJ3lIVg"
    }
  },
  "summary": {
    "Application URL Scheme": "tablika",
    "Application Name": "Tablika",
    "Application Bundle Identifier": "com.tablika",
    "Terms of Use URL": "http://www.tablika.com/terms-of-use",
    "Privacy Policy URL": "http://www.tablika.com/privacy-policy",
    "Help URL": "http://tablika.com/help/",
    "About Page URL": "http://tablika.com/about",
    "Portal URL": "https://portal.tablika.com",
    "Production URL": "tablika.com",
    "API Endpoint": "https://portal.tablika.com/api",
    "Brand": "main",
    "Anonymous Login": "Yes",
    "List Public Apps": "Yes",
    "Primary Color": "163,36,42",
    "Copyright": "Tablika © 2015"
  },
  "resources": [
    {
      "name": "Default.png",
      "url": "/api/v1/config/tablika.prod/resources/Default.png",
      "mimeType": "image/png",
      "desc": "Something"
    }
  ],
  "isReady": false
}

Config settings

Update config settings

PUT

/config/{name}/settings

Parameters
name
string (required)
Name of the config

RequestShowHide

Headers

Content-Type: application/json

Body

{
  "app": {
    "versionName": "1.0.0 TEST",
    "name": "Test Case",
    "bundleId": "com.monkey.testcase",
    "urlName": "cailmobility.dev",
    "urlScheme": "cailmobility.dev"
  },
  "config": {
    "url": {
      "termsOfUse": "http://cailmobility.com/terms-of-use/",
      "privacyPolicy": "http://cailmobility.com/privacy-policy/",
      "help": "http://cailmobility.com/help/",
      "about": "http://cailmobility.com/about/",
      "portal": "https://dev.cailmobility.net",
      "production": "cailmobility.com"
    },
    "api": {
      "url": "https://dev.cailmobility.net/api",
      "brand": "main"
    },
    "features": {
      "anonymousLogin": "No",
      "publicApps": "No"
    },
    "appearance": {
      "primaryColor": "14,65,134"
    },
    "hockeyApp": {
      "appId": "7e51807aa670b58b3a06d67a4d57e7c9"
    },
    "googleAnalytics": {
      "trackingId": "UA-62670622-1"
    },
    "copyright": null,
    "isProduction": "No",
    "introYouTubeVideoId": "DC_s9_M9UFk"
  }
}

Response 200ShowHide

Body

{
  "settings": {
    "app": {
      "urlName": "cailmobility.dev",
      "urlScheme": "cailmobility.dev",
      "name": "Test Case",
      "bundleId": "com.monkey.testcase"
    },
    "config": {
      "url": {
        "termsOfUse": "http://cailmobility.com/terms-of-use/",
        "privacyPolicy": "http://cailmobility.com/privacy-policy/",
        "help": "http://cailmobility.com/help/",
        "about": "http://cailmobility.com/about/",
        "portal": "https://dev.cailmobility.net",
        "production": "cailmobility.com"
      },
      "api": {
        "url": "https://dev.cailmobility.net/api",
        "brand": "main"
      },
      "features": {
        "anonymousLogin": "No",
        "publicApps": "No"
      },
      "hockeyApp": {
        "appId": "7e51807aa670b58b3a06d67a4d57e7c9"
      },
      "googleAnalytics": {
        "trackingId": "UA-62670622-1"
      },
      "appearance": {
        "primaryColor": "14,65,134"
      },
      "copyright": "Tablika © 2015",
      "isProduction": "No",
      "introYouTubeVideoId": "DC_s9_M9UFk"
    }
  }
}

Config Resource Collection

Upload resources

PUT

/config/{name}/resources

Parameters
name
string (required)
Name of the config

RequestShowHide

Headers

Content-Type: multipart/form-data; boundary=---BOUNDARY

Body

-----BOUNDARY
Content-Disposition: form-data; name="Default.png"; filename="Default.png"
Content-Type: image/png

...CONTENT...
-----BOUNDARY

Response 200ShowHide

Body

{
"warnings": [],
"files": [
  {
    "name": "Icon-76.png",
    "url": "/api/v1/config/testcase/resources/Icon-76.png"
  }
],
"errors": []
}

Config Resource

Get Resource

GET

/config/{name}/resources/{resName}

Content will be either an image or a vector based PDF.

Parameters
name
string (required)
Name of the config

resName
string (required)
The name of the resource including file extension.

Response 200ShowHide

Headers

Content-Type: image/png | application/pdf

Validation

Get Validation Status

GET

/config/{name}/validation

Parameters
name
string (required)
Name of the config

Response 200ShowHide

Headers

Content-Type: application/json

Body

{
"settings": {
  "isValid": false,
  "errors": [
    {
      "message": "this property is required.",
      "keyPath": "app.urlScheme",
      "$leaf": true
    }
  ]
},
"resources": {
  "isValid": false,
  "remainingFiles": [
    {
      "name": "NavigationBackground.pdf",
      "size": "320x64",
      "desc": "Navigation background",
      "mimeType": "application/pdf"
    }
  ]
},
"isValid": false
}