Sharpei icon

Sharpei

Consume Sharpei Api

Overview

The node integrates with the Sharpei API to manage customer data, specifically allowing creation of new customers. It is useful in scenarios where you want to automate adding customer records into the Sharpei system from workflows, such as after form submissions, CRM updates, or e-commerce checkouts.

For example, when a new user signs up on your website, this node can be used to create a corresponding customer record in Sharpei by providing their details in JSON format.

Properties

Name Meaning
Customer Data (JSON) The customer information to create, provided as a JSON object. Typical fields include first name, last name, email, customer type (e.g., individual), currency, phone number, user ID, and identification number.

Output

The node outputs the response from the Sharpei API after attempting to create the customer. This output is available in the json field of the node's output data and typically contains the newly created customer's details or an error message if the operation failed.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the Sharpei API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL for the API is https://api.prod.gosharpei.com/api.
  • The node expects JSON content-type headers for requests and responses.

Troubleshooting

  • Invalid JSON Format: If the "Customer Data (JSON)" property contains malformed JSON, the node will fail. Ensure the JSON is valid and properly formatted.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify that the API key/token is correctly set up in n8n credentials.
  • API Errors: If required fields are missing or invalid in the customer data, the Sharpei API may return errors. Check the API response for detailed messages and adjust the input accordingly.
  • Network Issues: Connectivity problems to the Sharpei API endpoint will result in request failures. Confirm network access and API availability.

Links and References

Discussion