Page tree

Versions Compared

Key

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

...

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

The interactive Armor API is divided into the following six sections: 

...

  1. Log into the Armor Management Portal (AMP).
  2. On the left-side navigation, click Account
  3. In the Overview screen, copy 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

...

  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, remove the sample login credentials, and then enter your AMP username and password.  
    • Do not remove the quotation marks. 
  7. In Parameter content type, select application/json
  8. Click Try it out!
    • If you have multi-factor authentication (MFA) set up for your AMP account, then you will need to authenticate in order to receive the code. 
  9. Under Response Body, copy the code, including the equal sign ( = ); however, do not copy the quotation marks.
  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 field under Value, remove the sample code, and then paste your code.
    • Do not remove the quotation marks. 
  14. In Parameter content type, select application/json
  15. Click Try it out!
    • This will display the access_token
  16. Under Response Body, 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 as FH-AUTH afecb1543c3de8654.
  18. Click Authorize
    • The screen will refresh.

...

Note

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

Warningnote

Although the button to execute the call is displayed as Try it out!, this feature the interactive Armor API guide is a live version of the Armor API. Certain These calls will cause real-time changes to your environment.

...