Page tree

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

Compare with Current View Page History

« Previous Version 35 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 the following six sections: 

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

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 high-level steps to authenticate:

  • Locate your account number
  • Locate your authorization code and authenticate

Step 1: Locate your account number

  1. Access and log into the Armor Management Portal (AMP).
  2. On the left-side navigation, click Account
  3. In the Overview screen, copy the number in Account Number
  4. Access the interactive Armor API (https://developer.armor.com/).  
  5. In the X-Account-Context field, enter the copied Account Number

Step 2: Locate your authorization code and authenticate 

  1. Access the interactive Armor API (https://developer.armor.com/). 
  2. Click the Authentication section. 
  3. Click POST /auth/authorize
  4. On the right side, under Data Type, click Example Value
  5. Click the yellow field below Example Value. 
    • This action will populate the empty field on the left. 
  6. On the left, in the field under Value, enter your AMP username and password.  
  7. In Parameter content type, select application/json
  8. Click Try it out!
  9. Under Response Body, copy the code, including the equal sign ( = ).
  10. Locate and select POST /auth/token
  11. On the right side, under Data Type, click Example Value
  12. Click the yellow field below Example Value.
    • This action will populate the empty field on the left.  
  13. On the left, in the filed under Value, remove the sample code, and then paste your code.
  14. In Parameter content type, select application/json
  15. Click Try it out!
    • This will display the access_token
  16. Copy the access_token
  17. Scroll up, and then in the Authorization field, enter FH-AUTH, followed by the copied access_token
    • A typical authorization credential should display is FH-AUTH afecb03c3de8654.
  18. Click Authorize
    • The screen will refresh.



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

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

  1. Click the desired API section (Account Management, Infrastructure, Authentication, Security, Network Services, Support), and then click the desired API call.  
  2. On the right, under Data Type, click Example Value.
  3. Click the yellow field below Example Value. 
    • This action will populate the empty field on the left. 
  4. On the left, in the field under Value, make your desired changes. 
  5. In Parameter content type, select application/json
  6. 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