Idea ID: 2867404

Overhaul of SMAX REST APIs & Documentation

Status : Waiting for Votes
2 months ago

Dear team,

As we continuously SMAX platform, there is a growing demand to achieve SMAX integrations with external systems, for use-case such as - case-exchange, collaboration tools, automation, 3rd party monitoring tools, reporting and data-extraction. For all such cases, practitioners need clear and detailed information on usage of SMAX REST APIs. While the quality of current documentation on APIs (Develop Section) has been steadily improving, but it needs to be much more structured and detailed to be effectively understood and used by field team and practitioners.

Here are some ideas where things can be improved.

  • Proper listing of all the endpoint/resources and supported operations GET/POST/PUT/DELETE with payload example.
  • API versioning can be incorporated to bring in enhancements and notify depreciations.
  • Documentation should contain code samples (for Java, Python, NodeJS, etc) for major entities and their operations
  • Would be excellent to have Swagger style API documentation and testing inside the product itself. The 'EMS Rest API' is very helpful, but needs to be matured further to reduce hit-and-trial approach.

References of few well documented APIs, which can be looked into for ideas.

Thanks,

Abhishek Danej

  • This will enable the implementation team to exploit the capabilities of SMAX as per the best practices, while specializing in third party integrations as many use cases are dependent on multiple business applications & functions. This will give more power to ESM framework, while reducing the noise on the ground.

  • This will be helpful to many system integrators - they can shorten their time to integrate while doing it 'the recommended way'. It will also help reduce support calls. 

  • Thank you for sharing your idea! It’s open for comments and kudos, and we’re looking forward to input from the community. Once there is enough community traction, it will be further reviewed by the product team.