Active Monitoring and API Documentation (Or, “Why Doesn’t My Call Work?”)

Active API Monitoring

One of the issues we frequently see is clients having issues with moving to active external monitoring from internal testing or testing through their API documentation system (like Apiary, Postman or others). The challenge is simple – if you’ve been making calls to your APIs from within your firewall you may not have experience in the issues that impact those calls. This post explores some of the common issues we see.

Custom Endpoint Name

When using our import service to pull in from a documentation system, the root URL of the API call might be specific to the documentation server rather than the actual API call you will deploy. While this can be acceptable for testing, you may want to be able to change that later.

Lack of Auth/API Key

Depending on the security used for the production API, you may need an API key or an OAuth Token for the API. If the call has been tested without the security layer, which is often set up in the gateway or API management system, this can be a forgotten step. Typically, this results in a 4XX error. APImetrics handles all forms of API security natively, but call security settings must be configured before proceeding.

Unhandled Parameters and Variables

Bulk importing an API call saves time, but it’s not magic. If your calls use variables or require data sourced by another process or API call, then you won’t be able to make the call successfully. Typically, this also results in a 4XX style error. Before setting up live calls, make sure all the required parameters and variables are correct.

APImetrics understands all of these issues – and we’re happy to help you get your first external, active API call made if you would like us to, we can take over the entire process for you.

Why not contact us to get started today?

Photo courtesy of Frank Hemme
[iee_empty_space type=”horizontal” height=”69″ width=”24″ hide_on_mobile=”small-visibility,medium-visibility,large-visibility” class=”” id=”” /][iee_dual_button button_1=”W2Z1c2lvbl9idXR0b24gbGluaz0iaHR0cHM6Ly9jbGllbnQuYXBpbWV0cmljcy5pby9yZWdpc3Rlci8iIHRpdGxlPSIiIHRhcmdldD0iX3NlbGYiIGxpbmtfYXR0cmlidXRlcz0iIiBhbGlnbm1lbnQ9IiIgbW9kYWw9IiIgaGlkZV9vbl9tb2JpbGU9InNtYWxsLXZpc2liaWxpdHksbWVkaXVtLXZpc2liaWxpdHksbGFyZ2UtdmlzaWJpbGl0eSIgY2xhc3M9IiIgaWQ9IiIgY29sb3I9ImRlZmF1bHQiIGJ1dHRvbl9ncmFkaWVudF90b3BfY29sb3I9IiIgYnV0dG9uX2dyYWRpZW50X2JvdHRvbV9jb2xvcj0iIiBidXR0b25fZ3JhZGllbnRfdG9wX2NvbG9yX2hvdmVyPSIiIGJ1dHRvbl9ncmFkaWVudF9ib3R0b21fY29sb3JfaG92ZXI9IiIgYWNjZW50X2NvbG9yPSIiIGFjY2VudF9ob3Zlcl9jb2xvcj0iIiB0eXBlPSIiIGJldmVsX2NvbG9yPSIiIGJvcmRlcl93aWR0aD0iIiBzaXplPSIiIHN0cmV0Y2g9ImRlZmF1bHQiIHNoYXBlPSIiIGljb249IiIgaWNvbl9wb3NpdGlvbj0ibGVmdCIgaWNvbl9kaXZpZGVyPSJubyIgYW5pbWF0aW9uX3R5cGU9IiIgYW5pbWF0aW9uX2RpcmVjdGlvbj0ibGVmdCIgYW5pbWF0aW9uX3NwZWVkPSIwLjMiIGFuaW1hdGlvbl9vZmZzZXQ9IiJdVHJ5IHVzIG91dFsvZnVzaW9uX2J1dHRvbl0=” button_2=”W2Z1c2lvbl9idXR0b24gbGluaz0iL2ZpcnN0LWFwaS1vbi11cy8iIHRpdGxlPSIiIHRhcmdldD0iX3NlbGYiIGxpbmtfYXR0cmlidXRlcz0iIiBhbGlnbm1lbnQ9IiIgbW9kYWw9IiIgaGlkZV9vbl9tb2JpbGU9InNtYWxsLXZpc2liaWxpdHksbWVkaXVtLXZpc2liaWxpdHksbGFyZ2UtdmlzaWJpbGl0eSIgY2xhc3M9IiIgaWQ9IiIgY29sb3I9ImRlZmF1bHQiIGJ1dHRvbl9ncmFkaWVudF90b3BfY29sb3I9IiIgYnV0dG9uX2dyYWRpZW50X2JvdHRvbV9jb2xvcj0iIiBidXR0b25fZ3JhZGllbnRfdG9wX2NvbG9yX2hvdmVyPSIiIGJ1dHRvbl9ncmFkaWVudF9ib3R0b21fY29sb3JfaG92ZXI9IiIgYWNjZW50X2NvbG9yPSIiIGFjY2VudF9ob3Zlcl9jb2xvcj0iIiB0eXBlPSIiIGJldmVsX2NvbG9yPSIiIGJvcmRlcl93aWR0aD0iIiBzaXplPSIiIHN0cmV0Y2g9ImRlZmF1bHQiIHNoYXBlPSIiIGljb249IiIgaWNvbl9wb3NpdGlvbj0ibGVmdCIgaWNvbl9kaXZpZGVyPSJubyIgYW5pbWF0aW9uX3R5cGU9IiIgYW5pbWF0aW9uX2RpcmVjdGlvbj0ibGVmdCIgYW5pbWF0aW9uX3NwZWVkPSIwLjMiIGFuaW1hdGlvbl9vZmZzZXQ9IiJdTGV0IHVzIGdldCB5b3Ugc3RhcnRlZFsvZnVzaW9uX2J1dHRvbl0=” alignment=”center” hide_on_mobile=”small-visibility,medium-visibility,large-visibility” class=”” id=”” separator_type=”string” sep_text=”OR” sep_icon=”” sep_background_color=”#ffffff” sep_color=”#000000″ typography_separator=”Open Sans:300″ /]

Leave A Comment

Go to Top