SAMi - Smart API Marketplace Documentation
Try It Out APIs-Feature to try and experience by testing APIs
Scenario 1: “Try it out” feature for selected products from the Home Page (Featured Products)
The “Try It Out” feature helps you try testing the APIs in Swagger and Redocs and experience it before subscribing to the product. To navigate to “Try it out” feature from the Home page, you need to do the following:
Log in as a Developer by providing your Email address and Password in the respective textboxes.
Click Sign In.
The Homepage is displayed.
3. Search a Product by using the Search Option on Home Page or Scroll down and click on View Product link of any selected Featured Product.
The Summary page is displayed.
4. In Summary Page, scroll down to view product details.
5. In the Product Summary page, scroll down to API Specs, choose the API needed and click on - “Try it” link.
6. You will view the “Swagger” or “Redoc page”, and you can try and test run an API to see the results. Click on Try it (Swagger) link.
7. Click on Try it (Redoc) link.
The Redoc specifications page appears.
The Redoc page with the API specification is displayed.
Scenario 2: “Try it out” feature for selected products from the Home Page (Explore Categories)
To experience “Try it out” feature from Search on the Homepage (Explore Categories), you need to login as a developer and navigate to explore categories.
Login as a Developer by providing your Email address and Password in the respective textboxes.
Click Sign In.
The Homepage is displayed.In Home page, scroll down to Explore Categories. Click on Browse Categories.
The Product Description page appears with all product cards.
4. Click on Read More link.
The product Summary page appears.
5. In Summary page, scroll down to the API Specs section.
6. Click on Try it (Swagger) link.
The API Specifications is displayed.
7. Scroll down to view the Swagger methods and endpoints to try.
8. Similarly, from the API Specifications page, click on Try it (Redoc) link.
The API Redoc Specification page is displayed.
9. Scroll down to view the methods and endpoints to try.
Scenario 3: “Try it out” feature for selected products from the Explore Page
Go to Homepage, click on Explore option on main menu.
The Explore page is displayed.
2. Search using the Available Filters by providing the product name and clicking on Search icon.
3. Click on Read More on the selected product card.
4. In the Product detail page, scroll down to API Specs click on “Try it out”.
5. Here, you will view the “Try it (Swagger)” link to try and test an API in Swagger or Try it (Redoc) link to try it in Redoc.
6. Click Try It (Swagger) link, to open Swagger API specs.
The Swagger page is opened with the API specs. Here you can click on any of the listed methods to view the endpoints.
7. At the same time, if you wish to open the Redoc API Specs page, click Try It (Redoc).
The Redoc API Specifications page is displayed.
8. Scroll down to view the API methods and endpoints to try.
Related content
© 2024 SID Global Solutions | https://www.mysami.io | https://www.sidgs.com | +1 484-218-0021