Orcanos REST API

Introduction

The Orcanos REST API enables seamless integration with test automation frameworks and other automated processes, allowing for efficient data exchange and automation of key processes.

Getting Started

Create an API User

Navigate to Admin > Users & Groups > Users.

Click the ‘+’ button in the bottom-right corner to create a new user.

Set the First Name to “API” and the Last Name to “User”, ensuring the Username is “API.User” (see example below):

For the API.User we recommend associating it with an email address from your company domain. You can use your own email address or a dedicated group email address. This way, if the API.User receives any email notifications from Orcanos, they will be properly delivered to you or your team.

Assign Projects and Permissions

When creating the API User, you must choose which user groups and projects to assign the new user. Please ensure the API user is assigned to all relevant projects and has the appropriate permissions.

Please refer to our Users guide for more information on assigning users with groups and projects.

Generate an API Key

Navigate to Admin > System Configuration > API.

Check the checkbox next to Enable API Key to generate a unique key.

Authentication with the API Key

To authenticate API requests, include the API key in the request header:

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://app.orcanos.com/ xxxxxx /api/v2/Json

https://app.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:

Popular Articles (FAQ)