Question

API to interface with Assyst and pull certain information

  • 27 July 2023
  • 7 replies
  • 341 views
T
Rank
Badge

Hi there,

I'd really appreciate any help with this.

Basically, we’re trying to leverage Assyst to solve a flawed Business process.

We’re looking to have some kind of Interface with Assyst to pull information from it, specifically,  a list of up-to-date SVDs and Product Names and ‘Application Owner’ of each SVD/Product.

We need to notify these ‘Application Owners’ that, for example, the SSL expiration is coming due. (this information is managed on a separate DigiCert tool)

So, based on the list of SVDs/Application owner, we pull from Assyst, we’d like to automatically open a ticket assigned it to the correct SVD/Application owner  to address their SSL expiration. 

Is that doable? and Where can I get information about any APIs that might help with that?

Many Thanks in advance,

Cheers,

T.Kaddo

 

7 replies

A
Rank
Userlevel 2
Badge +5

Hi

 

The REST API that assyst provides is available. 

 

You can use the RAML (GET https://{server}[:{port}]/assystREST/v2/raml) to start to discover its capabilities.

 

GET https://{server}[:{port}]/assystREST/v2/serviceDepartments is the entry point for the Service Department resource 

GET https://{server}[:{port}]/assystREST/v2/products is the entry point for the Products resource 

 

assyst can also notify an integration of changes (see Destinations and the External Messaging System)

 

Hope that is useful. 

T
Rank
Badge

Thank you very much Allan.
So where would I run the GET statement ?

 

I tried this directly in the browser but got nothing
https://Servername:443/assystREST/v2/raml

A
Rank
Userlevel 2
Badge +5

Typically you can explore the API via a tool like Postman or similar. Whatever API tool work for you really.

 

If you are considering an Integration it might also be worth talking to your account manager about support from IFS. Bridges and integrations are services we offer as consultancy.  

P
Rank
Userlevel 2
Badge +9

You may be able to achieve this with ETM. It can be used to periodically query assyst REST (e.g. to get the list of active SVDs) and conditionally create new tickets. 

As Alan has suggested - use Postman to explore the API to see if you can identify the data you want to work with.

R
Rank
Badge +4

@tkaddo Did you manage to get this working? 

 

I have done some successful API calls from the one provided in our normal IFS environment. I’m not sure on our assyst information so unsure where to check for the server or port details.

 

 

T
Rank
Badge

How do I login to the api via postman, what is the endpoint and params required the WIKI doesn’t seem to explain any of this unless I’m missing something

A
Rank
Userlevel 2
Badge +5

Hi

 

Logging in depends on what authentication mechanism you use with assyst. A client like POSTMAN gives you GUI options to guide you through configuring the client to do this (on the Authorization panel). Any assyst REST endpoint can be hit, all require authentication.

 

For example, to use Basic Auth from POSTMAN (if your server supports that) select “Basic Auth” and enter credentials. 

Reply


Terms & ConditionsCookie settings