Where to start with exploring REST api communication?

Completed

Sriram

December 22, 2023 13:22

Hi Team,

                I am planning to have a plugin on nx_server side to send kind of attendance of data to client if client requested.

                 To start with where I to have to look on video plugin or sample analytics plugin for communication between server and client via REST?

                 How to start simulating?

Thanks,
Sriram

0

• 

  Andrey Terentyev

  • Network Optix team

  December 22, 2023 16:27

  Hello,

  The best place to start from is here.

  https://meta.nxvms.com/docs/developers/knowledgebase/224-developer-program

  • Architecture overview for general understanding.

  https://meta.nxvms.com/docs/developers/knowledgebase/192-explore-platform-architecture

  • Integration capabilities overview

  https://meta.nxvms.com/docs/developers/knowledgebase/195-1-integration-capabilities--what-to-expect

  • Step-by-step guide for analytics plugin development.

  https://meta.nxvms.com/docs/developers/knowledgebase/200-introduction-to-creating-a-video-analytics-plugin

  Regarding "video plugin" if I understood you right, see plugin example in Video Source SDK.

  Regarding REST API, you could get yourself familiar with API documentation 

  https://meta.nxvms.com/doc/developers/api-tool/main?type=1

  Could you, please, give more detailed description of your business scenario? What's the objective?

  We would recommend a suitable solution.

  0
• 

  Sriram

  January 03, 2024 05:56

  Hi Andrey Terentyev,
      
                       Happy new year!
                       Thanks for your reply.
  
                       I am able to try out some of the examples for REST api's after installing trial version of VMS client and server.
                       I want to know basics of how nx_client and server communicates & works via REST api.
  
                      Ex: https://ipaddr:port/#/api-tool/api-getevents-get?type=1 if try this in webUI I could get the reponse body & response headers.
  
                      I want to know how server handles this GET request, do we have any source code reference for this REST api documentation so that I can try creating new events.
                     
                      Please help!
  
  Thanks,
  Sriram             

  0
• 

  Andrey Terentyev

  • Network Optix team

  January 09, 2024 15:12

  Hello,

          I want to know how server handles this GET request, do we have any source code reference for this REST api documentation so that I can try creating new events.

  Could you, please, give more detailed description of your business scenario? What's the objective? What events are you thinking about? What these events are supposed to do? We would recommend a suitable solution.

  0
• 

  Andrey Terentyev

  • Network Optix team

  January 09, 2024 15:13

  Hello,

          I want to know how server handles this GET request, do we have any source code reference for this REST api documentation so that I can try creating new events.

  Could you, please, give more detailed description of your business scenario? What's the objective? What events are you thinking about? What these events are supposed to do? We would recommend a suitable solution.

  0

Please sign in to leave a comment.