Follow

Managing Authentication in API Test Maker

The Manage API Authentication page allows you to create and manage API Keys and Basic Auth credentials for your tests.

The following video provides a brief introduction to managing API keys and basic auth in API Test Maker.

Manage API keys

An API Key is a key/value pair that is passed to the API to provide access control and authenticate an API request. If you are attempting to test an API that requires an API Key, you can define the key in the Manage API Authentication page. Once you define an API Key in API Test Maker, you can then assign that key to a specific API model so that the assigned key is used for all of the tests that you generate for that model.

Note: The API key is assigned to your tests at the time of generation. If you add an API key to a model with existing tests, you must regenerate those tests for them to use the assigned API key. If you update the API key, you must also regenerate existing tests for them to use the updated value.

Authentication.png

Create a New API Key

  1. Click Manage API Authentication in the menu bar at the top of the page.
    The Manage API Authentication page opens.
  2. Enter a brief description for the API key in the Description field.
    The description displays in a list of available API keys when you assign an API key to an API model. Ensure that it is descriptive enough to identify the desired key. The description value must also be unique.
  3. Enter the key name in the Name field.
    Typical values include api_key, apikey, key, or something similar. You must obtain the exact value from the API that you want to connect to.
  4. Enter the key value in the Value field.
  5. Select one of the following values from the In column:
    • Header: Places the API key in the request header.
    • Query: Places the API key as a parameter in the query.
  6. Click Save.
    Your API key is saved and available from the API Key list at the top of the Edit API Tests page for your model.

Modify an Existing API Key

  1. Click Manage API Authentication in the menu bar at the top of the page.
  2. The Manage API Authentication page opens.

  3. Make the desired changes to the API key description, name, or value.
  4. Click Save.
  5. To delete an API key:
    1. Click Delete ParameterDeleteIcon.png next to the API key that you want to delete.
    2. Click OK in the confirmation window.

Note: Deleting an API key that is currently assigned to a model removes the API key from the model. A confirmation window indicates the number of models that are currently using this API key. 

Assign an API Key to a Model

  1. Click Manage API Authentication in the menu bar at the top of the page.
    The Manage API Test page opens.
  2. Click the Name of the API model that you want to update.
    The Edit API Tests page opens. 
  3. Select the API Key that you want to apply to the model from the API Key list at the top of the page.
    The selected API key is applied to the model and is used for all of the tests that you generate from the model.

Manage Basic Auth

HTTP Basic Authentication (Basic Auth) lets you specify your credentials to your API by sending a user name and password to the API. You can provide Basic Auth only for a test, or you can provide both Basic Auth and an API Key.

If you are attempting to test an API that requires Basic Auth, you can define the credentials in the Manage API Authentication page. Once you define Basic Auth in API Test Maker, you can then assign those credentials to a specific API model so that the credentials are used for all the tests that you generate for that model.

Note: The Basic Auth is assigned to your tests at the time of generation. If you add Basic Auth to a model with existing tests, you must regenerate those tests for them to use the assigned credentials. If you update the Basic Auth, you must also regenerate existing tests for them to use the updated values.

Create a Basic Auth

  1. Click Manage API Authentication in the menu bar at the top of the page.
    The Manage API Authentication page opens.
  2. Enter a brief description for the Basic Auth in the Description field.
    The description displays in a list of available Basic Auths when you assign a Basic Auth to an API model. Ensure that it is descriptive enough to identify the Basic Auth credentials. The description value must also be unique, and cannot be the same as an existing API Key.
  3. Enter the user name in the User Name field.
  4. Enter the password value in the Password field.
  5. Click Save.
    Your Basic Auth credentials are saved and available from the Basic Auth list at the top of the Edit API Tests page for your model.

Modify an Existing Basic Auth

  1. Click Manage API Authentication in the menu bar at the top of the page.
  2. The Manage API Authorization page opens.

  3. Make the desired changes to the Basic Auth description, user name, or password.
  4. Click Save.
  5. To delete a Basic Auth:
    1. Click Delete ParameterDeleteIcon.png next to the Basic Auth that you want to delete.
    2. Click OK in the confirmation window.

Note: Deleting a Basic Auth that is currently assigned to a model removes the Basic Auth from the model. A confirmation window indicates the number of models that are currently using these Basic Auth credentials. 

Assign Basic Auth to a Model

  1. Click Manage API Authentication in the menu bar at the top of the page.
    The Manage API Tests page opens.
  2. Click the Name of the API model that you want to update.
    The Edit API Tests page opens. 
  3. Select the Basic Auth that you want to apply to the model from the Basic Auth list at the top of the page.
    The selected Basic Auth credentials are applied to the model and are used for all the tests that you generate from the model.
Have more questions? Submit a request

0 Comments

Article is closed for comments.