Page tree

Versions Compared

Key

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

...

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

Swagger The interactive Armor API is divided into five sections: 

  • 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 your account credentials.

There are two ways to authenticate into the tool: 

  • via Swagger and AMP
  • Via the command line

Via Swagger and AMP

  1. Access the interactive Armor API (Insert link). 
  2. In A

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

  1. Access the 






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. 

...