View and test actions
Once you've created actions for your service, you can view, test, update, or delete them from the service details page.
Created actions
Action Management
On the service details page, you'll find a list of all actions associated with that service. For each action, you can perform the following operations:
-
View: See all the details of the action, including its name, description, input type, and endpoint information.
-
Test: Try out the action to ensure it's working as expected. This feature allows you to input test data and see the response from your API in real-time.
-
Update: Modify any aspect of the action, such as its description, input parameters, or endpoint details. This is useful for refining your action based on user feedback or API changes.
-
Delete: Remove an action that is no longer needed or has been deprecated.
Actions details
Metadata Template Requirement
Before testing an action, it's important to note that partners are required to fill out the metadata template in their profile page. This metadata provides essential information about your service and actions, which is crucial for proper integration and functionality within the Snapshot ecosystem.
To complete the metadata template:
- Navigate to your profile page in the Partner Portal.
- Look for the "Metadata Template" section.
- Fill in all required fields with accurate and up-to-date information about your service and actions.
- Save the changes.
Completing the metadata template ensures that your actions are properly utilized by Snapshot. It also helps in providing a seamless experience for end-users interacting with your service through the Snapshot interface.
Profile page
Once you've filled out the metadata template, you can proceed to test your actions as described below.
Testing Actions
To test an action:
- In the action details page, Click on the "Test Endpoint" button which is located at the top of the page.
- You'll be presented with a modal with a Run button also located at the top right corner.
- The response will be displayed in the response section.
This testing feature ensures the reliability and accuracy of your actions before they are used in production environments.