OpenText APIs Quick Start Guide

Shahid M

The following steps will help you try out the APIs quickly after you've signed up for one of the free trials. We have 3 trials available: Services bundle, Signature, and Messaging.

If you need help, please identify which trial and the region you selected.

First, confirm the region where you have created your account by hovering over the Console menu option after you log in. For example, if you see “CA” next to your org name then that means your account is in the Canada Region.

To Authenticate, gather the following credentials (provided to you during the trial signup):

1. Tenant Id, Tenant Username & Password (if you don’t know the password, select your tenant in the Admin Console and select option to reset your password, as shown below)
   
2. Client Id & Client Secret (client id and secret from the app that you have created and assigned to the tenant)
   
3. If you do not have the client secret saved, you can regenerate the Service Client by going to the App at the Org level, as shown below
   
4. Add a redirect URL to test in Swagger on developer.opentext.com
   
   

To test the APIs, you can use the Swagger documentation.

1. For example, to test Content Metadata Service APIs, go to
   
2. The Authorization screen has a long list of servers and authentication methods to choose from. Pick the server based on the region and use the (OAuth2, password) authentication method
   
3. Once successfully authenticated, head back to the API documentation page and choose an API to try out.
   

A Dey

Hi I tried the exact steps listed here yet I'm getting the following error message when I try to get a bearer token to authorize my API calls:

"{
"fault": {
"faultstring": "Invalid ApiKey",
"detail": {
"errorcode": "oauth.v2.InvalidApiKey"
}
}
}"

Please help me out as we are unable to access any Opentext APIs without the bearer tokens

gvicari

You can verify with Postman and see if you can get a bearer token that way.
Procedure:

• Download and install Postman
• Create a POST request to the following
  URL:
  https://ca.api.opentext.com/tenants/<replace with your tenant id>/oauth2/token
  Headers:
  KEY: Content-Type, VALUE: application/json
  Request body:
  {
  "client_id": "<replace with your client id>",
  "client_secret": "<replace with your client secret>",
  "grant_type": "password",
  "username": "<replace with your username>",
  "password": "<replace with your password>"
  }
  OR alternatively (recommended for API to API / server side connections) request body:
  {
  "client_id": "<replace with your client id>",
  "client_secret": "<replace with your client secret>",
  "grant_type": "client_credentials"
  }

First try with username and password, as you can later on also use this in a OIDC/PKCE connection flow (using public client ⇒ this is the standard when doing browser / client side connections).

If you want more in depth information on how to set up and test a connection (e.g. also to your developer organization), please refer to the Developer Tutorial. In this developer tutorial, it helps you set up your VS Code Development Environment AND create a connection to your developer organization. This is also a good test, since if the developer organization connection doesn't work, chances are your app connection wouldn't either. Beware that in the developer tutorial it says you should connect to na-1-dev. You should choose ca.

A Dey

I followed these exact steps but I'm still getting the following error-
{ "error": "unauthorized tenant", "error_description": "authentication failed "}

gvicari

@A Dey, to validate the CA region is working, I have set up a brand new CA region trial account, created a simple application (which I can share if you like) in VS Code with OpenText Thrust Studio extension pack installed, deployed it to the CA region and tenant, and I have tested with both password and client_credentials grant types. This all works.

Beware though that for password grant type you need to add the user to your app in the tenant you deployed it to. More specifically, in Admin Center under /<organization name>/Tenants/<tenant name>/Apps/<app name>/users, make sure to add your test user (the organization user password doesn't work by default and it is also best you use application users) by clicking [+add] and filling an email address (of the test user) AND selecting ims_user as role. You should then get a user activation email in the user's email inbox. After setting user information and password, authenticating (getting a bearer token) with password grant type using the test user email and password should work.

Lastly, if you really want to use your organization user for password grant type, you will need to reset the password at the tenant level (as tenant level is specific and not set when creating an new trial/organization). To do that, just navigate in Admin Center to the tenant (go inside the tenant) and if you then click your profile, you should get the option to reset your tenant password, like so:

If things still don't work with the above, I recommend you create a new trial account to verify that it is not a problem with the account. If the other account works, you can let us know and we can investigate the original on. If it doesn't, you are most likely doing something wrong.

A Dey

I am using US region and forget about using API I can't even get the bearer token in the way you previously showed. If you want I can provide all the IDs and passwords you want and you can try it out yourself, I just want to get a bearer token and access the SMS outbound API. Why is the entire process so un-intuitive? Its supposed to be just a simple API call mate.

Let me know if you want me to share the creds in some secure medium. Just help me make an API call that gives 2xx codes, I'm fed up with all the different errors its throwing.

gvicari

@A Dey, from the ticket I was assuming you we in CA (this thread starts with CA region). If US, replace all ca with us.

Beyond that, you are right, this should be simple. Let's set up a call to go through the steps together. Can you please send me an email from your professional email address so that I can send out a meeting invitation? If available now, we can do this right away.

Kabir Raj Singh

Hi @gvicari . I am facing some issues while trying to access the API. Can we set a meeting right away? I need this for the hackathon.