The Data Health and Management page is designed to provide insights into your database synchronization, access management, and API integrations. This guide will help you understand each section and how to use it effectively for managing data health and user roles.
Key Metrics Overview #
Products and Variants #
Description: Displays the total number of products and their variants in your Replenit instance.
Usage: Use this metric to validate and sync your product catalog with the latest updates. It helps ensure that all available products are tracked correctly.
Unique Customers #
Description: Shows the total count of unique customers in your Replenit instance.
Usage: Monitor this number to ensure accurate synchronization of customer data between systems.
Total Transactions #
Description: Reflects the total number of transactions recorded in your system.
Usage: Use this metric to validate transaction syncing and health-check the completeness of sales data.
Access Keys Management #
Overview #
Description: Displays a list of active access keys used for secure API interactions.
Usage: Manage and monitor access keys to ensure secure communication between systems.
Key Actions #
- Generate Access Keys:
- Click the Generate button to create a new access key.
- Confirm the action in the dialog box.
- Use the generated key to integrate with third-party applications securely.
- Copy Access Keys: Click the Copy button to copy an access key to your clipboard.
- View Access Keys: Click the eye icon to view the full access key.
- Deactivate Keys: Ensure inactive or outdated keys are removed to maintain security.
User Management #
Overview #
Description: Displays a list of users who have access to the platform along with their roles and statuses.
Usage: Manage user roles and permissions to control access and ensure proper authorization.
How to Manage Users #
- Add a User:
- Click the Add User button.
- Fill in the user details, including email, first name, last name, and user role.
- Select a role from the dropdown. Admins will have full access, including the ability to make changes and push updates live, while Viewers can access all the details but will not be able to push anything to live.
- Click Submit to save the new user.
- Edit User: Click the Edit button to modify user details or roles.
- Delete User: Click the Delete button to revoke a user’s access to the system.
- Confirm the deletion in the dialog box.
APIs #
Overview #
Description: Provides a list of APIs available for integrating with the platform, along with client credentials and actions.
Usage: Use these APIs to synchronize customer, transaction, and product data with external systems.
Key Features #
- Client ID: The unique identifier for your API client.
- API Categories:
- User Data APIs: Manage customer-related data.
- Transaction Data APIs: Sync transaction information.
- Product Data APIs: Sync product and inventory data.
- Select an API category from the dropdown menu.
- API Documentation: Click the Docs button to access detailed API documentation for implementation guidance and API specifications.
Best Practices #
- Monitor Metrics Regularly: Use the top metrics to ensure data consistency and address discrepancies promptly.
- Secure API Keys: Deactivate unused keys and regenerate them periodically for enhanced security.
- Review User Access: Regularly update user roles to ensure proper authorization and remove inactive users.
- Utilize Documentation: Refer to API documentation for seamless integration and troubleshooting.