Orcanos REST API

INTRODUCTION

Orcanos REST API will be used for test automation integration

AUTHENTICATION

We are using Basic Authentication to authenticate with your credentials. In the basic authentication, a user needs to send the authentication key in the specific format.

To generate the key a user needs to contact the user name and password with colon sign (:) and encode the string with base64 encoder. It can be done with btoa and atob javascript function.

For example:

And pass the base64 string into the header field included with space and Basic keyword.

For example: 

Key : Authorization

Value : Basic dXNlcjE6dXNlckAxMjMK

How to encode the credentials into base64:

Format of Username and password should be like Username:Password

Example: User1:User@123

Convert this into base64 and it will be something like dXNlcjE6dXNlckAxMjMK

Note: From the Postman ( https://www.getpostman.com/ ) or any REST client testing tool, it can be added easily from the REST client UI. 

Authorization Header added in the Postman tool:

ERROR CODES

What errors and status codes can a user expect?

  • 500: An error has occurred or something was wrong
  • 200: Data is OK, Success
  • 401: Unauthorized, When Authorization token is not passed.

URL:

https://alm.orcanos.com/ xxxxxx /api/v2/Json

https://alm.orcanos.com/ xxxxxx /api/swagger/ui/index    

Where xxxxxx is a customer account name. Users can enter their account name here.

JSON RESPONSE:

In Success:

“IsSuccess” : true ,

“Data” : Full Information of related API function will display here.

“Message” : “” ,

“HttpCode” : 200

In Failure:

“IsSuccess” : false ,

    “Data” : Error Message will display here.

    “Message” : “” ,

    “HttpCode” : 500

 

REST APIs Library is here:

  1. QW_Login
  2. QW_Add_Defect
  3. QW_Add_Object
  4. QW_Delete_Object
  5. QW_Get_Object
  6. Get_Execution_Run_Details_XML
  7. Record_Execution_Results_New
  8. QW_Get_Item_Add_Edit
  9. QW_Save_Customer
  10. QW_Get_CustomerList_FromName

Leave A Comment?

You must be logged in to post a comment.