API Reference

API Overview

Reference for our RESTful API

Aplas provides a comprehensive API for modifying your software indexes. This provides you with the ability to integrate Aplas into your existing workflows (e.g. source-code workflow, or change management processes). This is one of the multiple methods for populating a software index.

Create an API key

  1. Within Aplas Studio, navigate to the config area.
  2. Select the API Keys section.
  3. Click to create a new key and specify a name.
  4. Once created, click Show to obtain the API key.

Access the API

  1. Review the API documentation
  2. Set a header of api_key to your secret.
  3. POST/PATCH/PUT all expect the content-type header to be set.

Example select query

curl -X GET 'https://api.aplas.com/api/v2/index/[your-index-id]/application/[your-application-id]' -H 'api_key:[your-api-key]'

Example create query

curl -X POST 'https://api.aplas.com/api/v2/index/[your-index-id]/application/' -H 'api_key:[your-api-key]' -H 'Content-Type: application/json' -d '{"id":"new_app","name":"New App"}'

Uploading an image to an application
Adding an image to an application requires 3 steps:

  1. POST to /api/v2/filespec to create a shared file reference. This will return a fileId that must be used for the following steps.
  2. POST your file data too /api/file/fileId.
  3. Update your application record with the fileId applied to the imageId field.