Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The interactive Armor API tool, powered by Swagger, is a cloud-based tool used to build, deploy, and document APIs. You can this tool to test and review the Armor API calls before you implement the calls. 

...

  • Authentication
  • Infrastructure
  • Network Services
  • Security
  • Support
  • Account Management

...

Access the interactive Armor API

To fully use the interactive Armor API, you must retrieve and input first authenticate into the tool with your account credentials and keys.

There are two ways to authenticate into the tool: 

  • via Swagger Via the API tool and AMP
  • Via the command line


Via Swagger and AMP

  1. Access In the interactive Armor API Management Portal (Insert link)AMP), in the top, right corner, click your username
  2. In A

To access the Swagger tool, you must retrieve login credentials. 

  1. Access the 
  1. the drop-down menu, select the desired account. 
  2. In the drop-down menu, select Settings.
  3. Copy your account number. You will need this information later. 

Via the command line

  1. Enter the login information for the Armor Management Portal (AMP). Review the following example.   

    Code Block
    POST /auth/authorize
     
    {
      "username": "user@domain.com",
      "password": "password123%^&"
    }
  2. If the authentication is successful, you will receive the authorization code (code). Review the following example. 

    Code Block
    {
     "redirect_uri": null,
     "code": "<<base64-hash>>"
     "success": true
    }
  3. Redeem the authorization code (code) to retrieve the access token and ID token. Review the following example.   

    Code Block
    POST /auth/token
     
    {
      "code":"<<base64-hash>>"
      "grant_type":"authorization_code"
    }
  4. If the request is successful, you will receive the access token (access_token) and the X-Account-Context (id_token). Copy this information. Review the following example. 

    Code Block
    {
     "access_token": "<<32-bit-uuid>>",
     "id_token": "<<base64-hash>>",
     "expires_in": 1800,
     "token_type": "Bearer"
    }
  5. Go to apidoc.tde.armorlabs.co.
  6. In Authorization, enter the access token (access_token). 
  7. In X-Account-Context, enter the ID for the account. 
    • You can use the GET https://api.armor.com/me API to find the account ID (id)
  8. Click Authorize. You can now use the form to locate and test API calls before you enter the command line. 

...

Add input parameters to Put, Post, Delete, and Get

Note

This section only applies to API call that require input parameters.

  1. Click the desired API section (Authentication, Infrastructure, Network Services, Security, Support, and Account Management), and then click the desired API call.  
  2. On the right, under Data Type, click Example Value, and then click the example to populate the blank filed under Value.  
  3. On the left, under Value, make your desired changes. 
    • The Parameter content type field must be configured to JSON.
  4. Click Try it out! The fields below will populate with your added changes, including the expected results. You can copy these fields and paste the information into the command line. 

...

Additional information

For more information on the Armor APIs, see Armor API Guide

...