Please ensure Javascript is enabled for purposes of website accessibility

integration connection validation using Swagger

Goals

  • to check whether an integration between smoove and an outside platform is working properly
  • How to do it?

    1. Go into smoove Swagger 
  • go to "settings" 
  • click on "API keys"
  • click on "API key link" on the relevant key row 
  • In the Swagger - 

  • TOKEN  - the API key 
  • choose the wanted action from the menu on the left 
  • Parameters – click on "body sample" on the right side of the screen 
  • complete the Parameters details according to your needs
  • *please note - actions that occurs in the Swagger occurs in the smoove account as well! 

  • validate integration connection -  
  • make sure that the output format is "application/json"
  • click on "try"
  • https://staging-blog.smoove.io/wp-content/uploads/2021/09/Smooves-Swagger-1.mp4

     

  • test result window -  
  • RESPONSE CODE - shows if the test was successful or failed 
  •  Response Messages - shows the code meaning 
  • if there is an error in the code -  
  • check the error meaning under "Response Messages"
  • change the code accordingly and try again 
  • copy the valid code into the main code 
  • https://staging-blog.smoove.io/wp-content/uploads/2021/09/Smooves-Swagger.mp4

    integration validation example - create update contact 

    https://staging-blog.smoove.io/wp-content/uploads/2021/09/smoove-21.mp4

    Adi Ben Yaakov

    האם הצלחנו לעזור?

    Leave a Reply

    Your email address will not be published. Required fields are marked *