Adding API libraries

Created by Ekaterina Zayats, Modified on Mon, 19 Sep 2022 at 09:39 AM by Boyko Cholakov

An API library contains a list of API objects for a product. To add an API library:


  1. Log in to your SIT Alemira Virtual Lab account.
  2. Click the profile icon in the right upper corner of the screen and select Settings.__________.png
  3. Click Add library and specify the following parameters:

    • Library name — the name of the library you intend to add.

    • Network location — the hostname of the server where the API is located.

    • Scheme — depending on the required security level, the protocol to use:

      • HTTP — HyperText Transfer Protocol.

      • HTTPS — HyperText Transfer Protocol Secure that requires SSL certificates.


  4. Click Next.
  5. Specify in Auth type the authorization type to use, depending on the required security level:

    • Basic Auth — to send in requests a username and password. In this case, specify:

      • Username — a username for authentication to be transferred Base64 encoded in request headers.

      • Password — a password for authentication to be transferred Base64 encoded in request headers.

      • Show password — leave the check box clear (or select if you want to show the password).


    • API key — to send in request headers a key-value pair for authentication. In this case, specify:

      • Header — the name of the header in which to pass the key-value pair.

      • Token prefix — the prefix used to mark the token.

      • Token — the authentication token as a text string.

      • Show token — leave the check box clear (or select if you want to show the token).


    • Bearer — to send in requests an authentication token. In this case, specify:

      • Token — a JSON Web Token (JWT) as a text string.

      • Show token — leave the check box clear or select if you want to show the token.


  6. Click Add.


Now you can add API objects to the library.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article