Introduction
Group Reference
Assessment Info (App Reference, Assessment Reference, & Task ID)
API Queries for AppRef, AssessmentRef, and GroupRef
API Queries for Task ID
 

Introduction

Using the NowSecure Platform API requires utilizing Reference and ID numbers from your app in certain curl commands and endpoints. These can be retrieved within the Platform UI and copied to your clipboard for use in the API.

When using the NowSecure Platform API, you will need to authenticate with a bearer token. See the Creating an API Bearer Token article for more detailed instructions.

In the NowSecure Platform UI, select your Profile in the upper right > Tokens.

Group Reference

Group Ref numbers can be found in the Package details page of your app in NowSecure Platform.

1. From the Apps page, select the name of the desired app to navigate to the Package Details page for that app.
2. Locate the Group heading on Package Details to find the name of the group to which the app belongs.
3. Select the Clipboard icon to copy the Group Ref to your clipboard.

Assessment Info

App Reference, Assessment Reference, & Task ID

There are several components of the Assessment Info that can be used in conjunction with the NowSecure API. This includes the app ref, assessment ref and task ID.

1. Navigate to the App Analysis report of your app and select the Debug tab.
2. In the Debug menu, select Assessment Info in the left navigation.
3. The App Reference, Assessment Reference and Task ID all have clipboard icons which you can use to copy the Ref or ID number to your clipboard.

API Queries for AppRef, AssessmentRef, and GroupRef

REST

Use the following endpoint to query the NowSecure API for all of the applications in your Platform Portfolio. You can then identify each app by the package name, and parse the response for the reference ID strings.

Note: This endpoint is available on the Platform API Hub: https://api.nowsecure.com.

GET /v2/portfolio/applications 

API Queries for Task ID

REST

Use the following endpoint to query the NowSecure API for an app's assessments. You may then parse the assessment info in the response for the Task ID, labeled "Task." You will need to include the groupRef of the app as a parameter of the call.

Note: This endpoint is available on the Platform API Hub: https://api.nowsecure.com.

GET /app/:platform/:package/assessment?group="groupRef"

Parameters

cURL 

Use the following cURL to query the NowSecure API for the specific Task ID from an assessment. You will need to first find the groupRef for the desired app assessment.

 query{
  auto{
    applications (groupRefs: "") query{
      packageKey
      title
      latestAssessment {
        taskId
        analysis {
          task {
            dynamic { id }
          }
          artifacts {
            displayName
            url
          }
        }
      }
    }
  }
}