Guidelines for using ExpoPlatform API

  • Make sure that you have the latest ExpoPlatform API documentation, Base URL, and API key from your API manager to build the API request.

  • Make sure you have gone through the “Response” section from the documentation of the endpoint you are using to make sure error codes are stored and handled appropriately.

  • Please make sure to store the response code, IDs, and other parameters received in response whenever a POST or DELETE request is made to the server.

  • If the volume of data is high, please make sure the data is pushed in multiple streams.

  • For updating records on Expoplafrom via API, make sure only the changed parameters are passed in the request and not the complete payload.

  • Make sure to perform testing of the integration with your API Manager by passing 3 or 5 test cases which are signed off by all the parties.

  • Before proceeding with the testing phase please submit the “Proposed Solution Document” with the logic flow diagram and pseudocode to your API Manager for review.

  • If you are using any endpoints with the GET method which are used to retrieve data from the system in bulk then these should be used with the appropriate timestamp filter as mentioned below.

    • Visitors List:- Only the 1st API pull should be done with timestamp = 0, all the next API calls should pull the delta/changed records since the last API call. Hence the timestamp of the last API call should be passed in its next consecutive request.

    • Synchronize data:- Only the 1st API pull should be done with timestamp = 0, all the next API calls should pull the delta/changed records since the last API call. Hence the timestamp of the last API call should be passed in its next consecutive request.

    • User Data:- As mentioned in the documentation

    • Meeting Export:- Use the time_from and time_to filter

    • Statistics Endpoint :- Use the time_from and time_to filters

  • send_email parameters if passed as true will trigger an email to the user. Hence it should be passed as true only when an email is expected to be triggered to the user or else it should be passed as false or not passed in the request at all.