Topic: API
CollabTools API
Interacting with the CollabTools API There are 4 overarching requirements to enable interaction with the CollabTools API: an active account for the CollabTool a personal access token for the CollabTool additional headers application specific permissions A reminder that PKI credentials are ALWAYS required no matter what authentication path (API or GUI) you use. Active Account You will need to have an active account in the CollabTool for which you want to make API calls.
Interacting with the CollabTools API There are 4 overarching requirements to enable interaction with the CollabTools API: an active account for the CollabTool a personal access token for the CollabTool additional headers application specific permissions A reminder that PKI credentials are ALWAYS required no matter what authentication path (API or GUI) you use. Active Account You will need to have an active account in the CollabTool for which you want to make API calls.
Registering for DoD Machine Certificate
Requirements and Steps to Register for a Machine Certificate Your machine certificate can take the same actions as your personal certificate. Requirements Common Access Card (CAC) NIPR email access Request A DOD Machine Cert If you already have a certificate, you can skip to the next section. To request a DoD certificate, follow these steps; you will need a CAC to complete this process. Generate a Certificate Signing Request (CSR) for the user.
Requirements and Steps to Register for a Machine Certificate Your machine certificate can take the same actions as your personal certificate. Requirements Common Access Card (CAC) NIPR email access Request A DOD Machine Cert If you already have a certificate, you can skip to the next section. To request a DoD certificate, follow these steps; you will need a CAC to complete this process. Generate a Certificate Signing Request (CSR) for the user.
Using Python with the ReST API
Try pycons3rtapi for an easy way to get started using the ReST API with Python 2.7. Prerequisites We suggest using the requests package to make ReST API calls with python, and the requests_toolbelt package to assist in calls using large file uploads like asset imports. Use pip to install prerequisites: pip install requests pip install requests_toolbelt Use an ECA Certificate with python Once requests is installed, you can leverage it to add your client ECA certificate to API requests to Arcus.
Try pycons3rtapi for an easy way to get started using the ReST API with Python 2.7. Prerequisites We suggest using the requests package to make ReST API calls with python, and the requests_toolbelt package to assist in calls using large file uploads like asset imports. Use pip to install prerequisites: pip install requests pip install requests_toolbelt Use an ECA Certificate with python Once requests is installed, you can leverage it to add your client ECA certificate to API requests to Arcus.
Make ReST API Calls with an ECA Cert
Set up Your Account to make ReST API Calls You can make ReST API calls using your Username, ECA certificate, and an API token To find your Username, click on the Profile Icon on the top-right, and select Profile & Account Click here for information on obtaining an ECA Certificate Register your ECA Certificate or Add an ECA Certificate to you existing Account Create an API Token Sample ReST API Calls on Linux In order to make ReST API calls on Linux, you may need to convert your ECA certificate (p12 or pfx file) to a PEM file with a private key.
Set up Your Account to make ReST API Calls You can make ReST API calls using your Username, ECA certificate, and an API token To find your Username, click on the Profile Icon on the top-right, and select Profile & Account Click here for information on obtaining an ECA Certificate Register your ECA Certificate or Add an ECA Certificate to you existing Account Create an API Token Sample ReST API Calls on Linux In order to make ReST API calls on Linux, you may need to convert your ECA certificate (p12 or pfx file) to a PEM file with a private key.
API Tokens
An API token is needed to access the Arcus ReST API on a per project basis. To create an API token: Generate a Project API Token Click on the person icon in the top right corner and select the “Profile & Account” option from the dropdown menu. Select Security and scroll down to API Tokens Click the Generate Token button next to the desired project. The token will appear and you will also receive a confirmation email.
An API token is needed to access the Arcus ReST API on a per project basis. To create an API token: Generate a Project API Token Click on the person icon in the top right corner and select the “Profile & Account” option from the dropdown menu. Select Security and scroll down to API Tokens Click the Generate Token button next to the desired project. The token will appear and you will also receive a confirmation email.