Sedona API / SedonaCloud POSTMAN calls and Testing

Sedona API / SedonaCloud POSTMAN calls

If you have not yet created users for your company, you will need to log into your site using the HostAdmin account.

 

Using a Host Admin Credential login to your company host SW 2.0 site

If you do not have the password and have setup your SMTP settings you can use the forgot password option.

Once logged in, you can create company user logins to access the company.

Go to Users, then select Add New User

 Graphical user interface, text, applicationDescription automatically generated

Enter the user information and select a Role. Be sure to select the new company name for the user. [Sedona X is not required for API testing]

If you are testing APIs with Postman or keys, use the information below.

The API uses OAuth 2.0.
 
 You can use the settings below for your collection.
 
 You will need to create a Company User account to use to get the token. 
 
 You can setup a user just for the API use or any users login.
 If you have more than one company, you have to select which company they will use when sending requests.
  These are the settings needed for Postman 
 
     Authorization type: OAuth 2.0
 
     Add auth data to: Request Headers
 
 Under the Configure New Token section
 
     Grant Type: Password Credentials
     
Access Token URL https://[YOUR-SEDONAWEB2-SITE-HERE]/connect/token
     
 Client ID: SedonaCloudClient  
     
Client Secret (API KEY):   [Provided in original Professional Svcs Project Documentation or from Octopus]

    Username: Company User Login created in the step above or designated
 
     Password: Company User Password created in the step above or designated
 
    Scope: sedonacloudapi sedonacloudscope openid offline_access
 
     Client Authentication: Send as Basic Auth header

The API Documentation can be found at the link below.

    URL https://[YOUR-SEDONAWEB2-SITE-HERE]/api/help/index.html

Below is the setup for a test collection in Postman.

 
Graphical user interface, applicationDescription automatically generated


If you need further assistance with API calls or custom work for an integration beyond user creation, this will be beyond normal support and we can have your account manager follow up with you to scope out a project for your needs.

Was this article helpful?
Thank you for your feedback!
User Icon

Thank you! Your comment has been submitted for approval.