The Customer Management APIs provide a comprehensive set of endpoints for handling customer data within the application. These APIs enable businesses to manage customer information effectively by allowing the creation, retrieval, updating, and deletion of customer records. By using these APIs, developers can build seamless workflows for customer onboarding, profile management, and data handling, ensuring a centralized and organized approach to managing customer data. The endpoints support operations to add new customers, retrieve specific customer information, update details, and delete customers as needed, making it easy to integrate customer management functionality into various applications.
Getting started:
To create a customer, you would need to generate your API Keys : These keys include Public keys & tokens, they would be generated and retrieved from the Settings module of the Torus Mara dashboard. To generate them, you would need to provide a unique key which should be kept secret and saved somewhere but should not be shared.
You would also need the SHA 256 - which is a combination of the Public keys and your customer reference ID (The unique ID for your customer), to generate a signature required to create your customer.
Create Customer
This endpoint allows the creation of a new customer profile by accepting necessary details like name, contact information, and other relevant data. It returns a unique customer ID upon successful creation, which can be used for future reference and operations on that customer.
Update Customer
Modify details of an existing customer using their unique ID. This endpoint enables updating specific customer information, such as contact details or profile attributes, ensuring customer records remain current and accurate.
Get Customer by ID
Retrieve the details of a specific customer by providing their unique ID. This endpoint returns comprehensive information about the customer, allowing quick access to their profile for review or other operations.
Delete Customer
Remove a customer’s profile from the system using their unique ID. This endpoint deletes the customer record, which is useful for data management and compliance when customer accounts are no longer needed.
Get All Customers
Fetch a list of all customers, with optional filters for sorting or specific attributes. This endpoint provides a complete view of customer profiles, supporting use cases like analytics, reporting, or bulk management.