Imprzd API Reference Guide

🚀Getting Started

Welcome to the Imprzd API workspace. The Imprzd API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

⚒️Pre-requisites

Before utilizing these APIs, ensure the following pre-requisites are met:

• Account Creation: Make sure your Imprzd account has been successfully created.
• Customer Segments: Finalize the criteria for segmenting your customers based on your marketing objectives.
• Campaigns: Ensure that the Imprzd team has created the campaigns for all the finalized customer segments to ensure seamless automation of your marketing efforts.

Once these pre-requisites are fulfilled, you can proceed to leverage the APIs to automate the execution of your targeted marketing campaigns.

🔑Authentication

All the Imprzd APIs are authenticated using JWT Bearer Token. JWT Token should be included in the 'Authorization' header for each request with the prefix 'Bearer'.

You can generate a JWT token by invoking the login API. If the API authentication fails due to invalid or expired token, you can regenerate the token using the login API.

🐞Handling Errors

Imprzd uses conventional HTTP response codes to indicate the success or failure of an API request. In general,

• codes in the 2xx range indicate success,
• codes in the 4xx range indicate failure due to an error in the API request,
• codes in the 5xx range indicate failure due to an error with Imprzd's servers (these are rare).

Imprzd provides detailed descriptions in the API response in case of a failure. Hence, you can handle the 4xx errors accordingly in your code.

📞Help and Support

If you have any questions or need further assistance, please do not hesitate to reach out to us at hello@imprzd.com.