Hi,

As you just found the new module, I would advise to have a look at the bootcamp recording session that cover this, as they will higlight IWrite-plugin and OpenAPI REST Web Services availability.

•  Let's Make Your Work Easier: Meet Publication Hub! 
•   Does Tridion Docs have a RESTful API?  

Best wishes,
Dave

Hi  Dave,

Thank you very much for your suggetion.  I found publication hub is only available in OpenAPI and I couldn't find any description about  restful API in Tridion Docs 15.1 documentation.  So will Restful API feature be released in future versions? Thanks！

These are the two most relevant bootcamp videos that cover the new Publication Hub and also the OpenAPI REST availability:  

Tridion Docs 15.1 (Alf1) Bootcamp 5of5 - Public Soap And Rest API
Tridion Docs 15.1 (Alf1) Bootcamp 3of5 - Publication Hub and Organize Space

Thank you for your help. I have found OpenAPI documentation, but I found that the API  for get a assignee has not been implemented yet. So I would like to ask if there are any other ways for me to get a assignee? For example, through database queries? Thanks !

Hello Zhu JH ,

OpenAPI public documentation is in progress and will be available in the upcoming weeks on docs.rws.com as well as on our developers' website developers.rws.com
Locally in your environment, you can browse Swagger UI to explore available API
That should be under http://Host:port/ISHWS/api/api-docs/index.html
You can use 
POST v3/Projects/Get
or 
POST v3/Projects/ByProjectId/Get
by specifying fields to get assigneeCardId that is a property on Project object
assigneeCardId can be used in PUT v3/Projects/ByAssigneeCardId/{assigneeCardId} to update Project assignee 

GET assignee call will be available in the upcoming release

Maybe you can also share your use case to understand what you are trying to achieve. 

Hi Andriy,

    Thank you very much, this is a great idea. However, during the process of invoking OpenAPI, I still encountered two problems:

1、 If I use  swagger ui of "/ISHWS/Api/api-docs/index.html", before invoking a restful API, I must enter an access token in the authentication module, but how can I obtain the value of this token? I couldn't find a login or authentication API to retrieve it.

2、If I use  swagger ui of  "/ISHCS/OrganizeSpace/oapi/api-docs/index.html", I don't need to enter an access token, I just need to log in to the organizespace.

But when I invoked POST v3/Projects/ByProjectId/Get ,  I got the following response but did not include assigneeCardId:

[ { "projectId": "GUID-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "publicationTitle": "test0613", "publicationVersion": "1", "id": "GUID-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "Project" } ]

So how should I fill in fields to obtain assigneeCardId in response?

Would you mind helping with these two problems? Thanks!

\

Hi Andriy,

    Thank you very much, this is a great idea. However, during the process of invoking OpenAPI, I still encountered two problems:

1、 If I use  swagger ui of "/ISHWS/Api/api-docs/index.html", before invoking a restful API, I must enter an access token in the authentication module, but how can I obtain the value of this token? I couldn't find a login or authentication API to retrieve it.

2、If I use  swagger ui of  "/ISHCS/OrganizeSpace/oapi/api-docs/index.html", I don't need to enter an access token, I just need to log in to the organizespace.

But when I invoked POST v3/Projects/ByProjectId/Get ,  I got the following response but did not include assigneeCardId:

[ { "projectId": "GUID-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "publicationTitle": "test0613", "publicationVersion": "1", "id": "GUID-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "Project" } ]

So how should I fill in fields to obtain assigneeCardId in response?

Would you mind helping with these two problems? Thanks!

\

Hello Zhu JH ,

You can use "/ISHCS/OrganizeSpace/oapi/api-docs/index.html" to get authentication through the Organize Space and play with Swagger UI via the browser.
If you want to know more about how to interact with OpenAPI with Modern Authentication you can take a look at the blog that was already suggested above
Does Tridion Docs have a RESTful API?  in the linked recording there is a coding session explaining Modern Authentication
There are also a couple of other useful blogs you can take a look:

• 
  How you could build a custom Web Application using Modern Authentication on Tridion Docs 15? 
•  Automating on Tridion Docs - ISHRemote v8.0 with Modern Authentication is now available  
  
  
  For  POST v3/Projects/ByProjectId/Get you can use the following model to get projectAssignee level details 
  

  {
    "projectIds": [
      "GUID-xxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
    ],
    "selectedProperties": "titleAnddescription",
    "fieldGroup": "all"
  }

Hello  Andriy,

     Thank you very much for your help. With your suggestion  on using POST v3/Projects/ByProjectId/Get ， My doubt about how to manage projects by API has been resolved.

     However, I still haven't found the answer to obtaining  access token from the blogs you shared.

    Unlike the solutions provided on these blogs, I am using Java programs or tools like Postman API Platform to directly call the OpenAPI. Does Tridion Docs OpenAPI support calling like I do?  Thanks!

Hi Zhu JH,

I do think that  Automating on Tridion Docs - ISHRemote v8.0 with Modern Authentication is now available  and in turn the source code it links to contains the conceptual answers you need. We should all be very warry that we do not see security as a hurdle to climb on making things work. We are all responsible for making things working securely.

Could you highlight at least what kind of authentication you have in mind?

1. Either a real user that uses his browser to follow the authentication flow, see "OpenIdConnect Authorization Code Flow with PKCE Flow"
2. Or more a program, ONE user that does everything like a service, see "OpenIdConnect Client Credentials Flow"

See also the standard on https://openid.net/developers/how-connect-works/ and certified client libraries (there are more, but these have been quality checked) on https://openid.net/developers/certified-openid-connect-implementations/ (ISHRemote uses the C# IdentityModel.OidcClient listed) ... what these libraries fascilitate is explained on various Youtube videos like this 7 minute intro on "An Introduction To OpenID Connect - YouTube" https://www.youtube.com/watch?v=6DxRTJN1Ffo 

Best wishes,
Dave

Hi  Dave,

    The authentication method I am familiar with is similar to  POST /authentication/api/1.0/login/signin of GroupShare or  POST /api/v2/auth of Language Weaver. I could call the Rest API within username and password as parameters and got tikcet or token as response. Is there an authentication API in Tridion Docs APIs?

Hello Zhu JH ,
OpenAPI does not have an authentication endpoint. Authentication is done via Access Management 
To learn about it you can read a blog from Dave: How did we do Modern Authentication in Tridion Docs 15?
as well as read public documentation: https://docs.rws.com/1151795/787727/tridion-docs-main-documentation/using-tridion-access-management
The resources that were suggested in the above answers explain how to integrate a custom application with Trdion Docs modern authentication.
If your purpose is just to make a couple of calls via Postman you can follow these high-level steps:
- obtain clientId and clientSecret for Tridion Docs Content Manager API Client  from  Access Management
- use clientId and clientSecret to get an access token from Access Management. Endpoint: https://host:port/access-management/connect/token
- use access token as bearer token and pass it via Authorization Header to OpenAPI endpoint
Postman allows you to configure all in your OpenAPI request on the authorization tab you specify AutherizationType Auth2.0 with request headers, token endpoint, clientID, and clientSecret and get the token after that

and then you can use that token for your OpenAPI request

Hi Andriy,

      I have tried using Postman to obtain the access token based on your suggestion, but I got  an error response as the following screenshots show.

       I  checked and found that the URL and parameters should be correct, so would  you please help me check what the problem is? thank you!

[edited by: Alvin Reyes on 14 Aug 2024, redacted some details and uploaded new screenshots] 

I recreated the screenshots with authentication details hidden (it's probably a good idea to use Postman variables to hide those details in the future).

I'm not sure if you got this working, but from the screenshot it seems the URL for the token might not be correct or there is some other issue getting to the endpoint, due to the 404 error. 

Also, knowing what you're trying to achieve as Andriy asked earlier can help. Though Publication Hub is new with Tridion Docs 15, you might not need to use it directly for an integration. For example, are you trying to send statuses to WeChat or other systems during certain actions in the Content Manager?