Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »



In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




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 API calls before you implement the calls. 

The interactive Armor API is divided into five sections: 

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

Access the interactive Armor API

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

There are two ways to authenticate into the tool: 

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


Via Swagger and AMP

  1. Access the interactive Armor API (https://developer.armor.com/). 
  2. Click Authentication
  3. Click /auth/authrotize
  4. On the right side, under Data Type, click the Example Value box.  
    • This will populate the empty field on the left. 
  5. Click Try it out!
  6. Under Response Body, copy the code, including the equal sign ( = ).
  7. Locate and select /auth/token
  8. Under Data Type, click the Example Value box. 
  9. Paste your code into the field on the left. 
  10. Click Try it out!
    • This will display the access_token
  11. Copy the access_token
  12. Scroll up, and then in the Authorization field, enter FH-AUTH, followed by the copied access_token
    • FH-AUTH afecb03c3de8654
  13. Access the Armor Management Portal (AMP).
  14. On the left-side navigation, click Account
  15. In the Overview screen, copy the number in Account Number
  16. Return to the interactive Armor API.
  17. In the X-Account_Context field, enter the copied Account Number. 
  18. Click Authorize
  19. (Optional) You can click Authentication, and then click Get / me to find the account number for your other accounts. 

Via the command line how to handle a user with multiple accounts

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

    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. 

    {
     "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.   

    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. 

    {
     "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

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

For more information on the Swagger product, please visit the Swagger website