Is there a swagger page for ECM API?

I believe I already know the answer but was hoping for someone who knows for sure what the answer is.

Is there a swagger/help page for the ECM API?

1 Like

Not that I’m aware of - but let me reach out to some folks and see what I can come up with.

1 Like

At a previous insights when @MikeGross and I were starting our REST quest I got a picture of a documentation site from the person manning the DS booth. It is not a swagger page, but has good info.

https://pedro.docstar.com/eapi24.1/ with the ending being the version number. My picture on my phone has 21.1, but the latest of 24.1 also loaded.

7 Likes

Beat me to it!

3 Likes

Do you mean the picture I took and gave to you?:joy::joy:

I was trying that today with my instances website and not the Pedro one. Thanks for letting me know I needed to actually put the exact website in!

3 Likes

I can’t find a newer link, but here’s a page for the DB Schema
Services at https://dev.docstar.com/EclipseServer

2 Likes

Do any of you have QuickShip ECM integration setup and working with the ECM API? I know I just reviewed the information support gave and they basically gave the customer the information that the default ECM website would connect and authorize QuickShip to integrate to ECM.

1 Like

I do not

not yet. I read the info when I upgraded them to 24.1, but have not attempted it yet.

1 Like

I think maybe this API information might help, but the documentation on what is needed is pretty light.

1 Like

hoping to get it going in the next week or two. Will report back :slight_smile:

2 Likes

Anyone has got it working ? It seems like everytime I call an URL like
https://(serverurl)/EclipseServer/AstriaV2/Administration.svc/restssl/GetUDT

I get an HTTP 404 error: The resource cannot be found.

The cloud beta link is working: https://cloudbeta.docstar.com/EclipseServer/AstriaV2/Administration.svc/restssl/GetUDT
It says : Method not allowed, which at leasts tells me that it would work by calling the POST

We’re installed on premise, not cloud. Not sure if that matters. And in our licenses, I see that ā€˜API’ is ā€˜Enabled’

Trying multiple ways on my box but nothing is working. I did figure out that each of the SVC files in c:\Program Files\Astria Solutions Group\Eclipse Server\AstriaV2 have a similar help page. Just substitute the SVC name into that URL for the cloud and you get the Help page.

I got it !!

https://(URL)/(Server)Server/HostingV2/User.svc/restssl/LogIn
Where:

  • (URL) = your url to access ECM
  • (Server) is the / at the end. For exemple, mine is (URL)/DEVECM normally so I simply have (URL)/DEVECMServer with the rest of the calls and it works

To find this, I simply opened ECM and clicked on something, for examples, ā€˜Groups’ in the ā€˜Admin’ page. By activating the browser’s developer console, in the ā€˜Network’ tab, I saw the API call and double clicked to get the full URL called

And then, once you have the token from that call, use it in the header as ā€˜ds-token’

5 Likes

Just for more clarity, as it may help some others out there.

My URL is normally
https://<servername>/docstarweb
and that does not work by adding the ā€œ/AstriaV2/role.svc/restssl/helpā€

Nor does it work if I simply add ā€œserverā€, per the example above, to get https://<servername>/docstarwebserver/AstriaV2/role.svc/restssl/help

Oddly, I had to change the URL to
https://<servername>/DocStarServer/AstriaV2/AffiliatedOrganization.svc/restssl/help

A little more digging yielded that ECM is actually multiple ā€˜applications’ under the Default Web Site in IIS. And the DocstarServer Application handles all the API calls, where the others handle the browser UI and reporting/DB Synching. Could be my original Docstar implementation from before it was an Epicor product - I’ve never looked at the IIS side that hard.

4 Likes

4 posts were split to a new topic: Create Document in ECM through API