{"info":{"_postman_id":"27066c51-74a7-495c-b0cf-7a25fb1091ae","name":"Imprzd Login Flow API Guide","description":"

🚀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.

🐞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.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28328713","collectionId":"27066c51-74a7-495c-b0cf-7a25fb1091ae","publishedId":"2sA35BaiUB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-25T04:41:01.000Z"},"item":[{"name":"Campaign_url","id":"06db1545-d359-46b7-8f1e-e7453ece5bc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"merchantID\":\"{{Encoded MerchantID}}\"\r\n\"segmentID\": \"{{SegmentID}}\",\r\n\"segmentType\": \"{{SegmentType}}\",\r\n\"username\": \"{{Name of the User}}\",\r\n\"userId\":\"{{ID of the User}}\",\r\n\"segmentInfo1\": \"{{addl.info of the segment}}\",\r\n\"segmentInfo2\":\"{{addl.info of the segment}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"www.imprzd.com/BroadcastImpression/api/campaign/createUrl","description":"

API Usage:

Recommended Trigger Point: Setup a Button code in the Merchant Web site or APP.Recommended Segmentation: Campaigns would be Pre-mapped corresponding to the Product ID and Customer Type.

Ecommerce Business Use Case: Demographics: Segment customers by age, gender, and location.

Purchase Behavior: Segment customers based on their past purchase behavior, such as purchased product category, order history, frequency, and preferences.

Education Business Use Case:

Course Discipline: Segment students enrolled in specific courses.

Demographics: Segment students based on age, location, and qualification.

Top Performers: Segment top-performers in each discipline.

Other Industries: For businesses in other industries or with unique segmentation requirements, please reach out to us. We are here to provide personalized suggestions and guidance on how to best utilize the API for your specific use case.

API Definition: This end point helps to fetch the Proposed Custom Campaign_URL. You can use this endpoint to run your campaigns in auto-pilot from your web site/APP entry point.

It allows you to:Send the specific parameters.Validate the parametersReturn the Encoded Campaign_url in real time response.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

PARAMETERS	DEFINITION,USAGE & EXAMPLES
segmentID mandatory	String SegmentID which identifier to the user for segmentation which is used to Segmentize the Campaign. For E-commerce: SegmentID can be a Product ID which is associated with the User. For Edu Tech: SegmentID can be a Course ID which is associated with the Student.
segmentType mandatory	String The SegmentType is to segment the User Nature which is used to segmentize the user For E-commerce: User Type would be Customer Type (New/Repeat/Prime) etc.. For Edu Tech: User Type would be based on the Student (New/Alumini/Toppers) etc..
username mandatory	String The Username is to get the Full Name of the user. For E-commerce: Full Name of the Customer. For Edu Tech: Full Name of the Student
userId mandatory	String The userId - Unique identifier of the user at Merchant System. For E-Commerce: Customer ID Assigned in Merchant System. For Edu Tech: Student ID assigned in their Eductional Instituational System.
segmentInfo1 optional	String The SegmentInfo1 is used to pass the Gender info (M/F) related to Segmentation to select the Gender specific Images to the post creation. For E-commerce: In this parameter, Gender Information related to the product Segment can be sent. For Edu Tech: In this parameter, Gender Information related to the Course Segment can be sent.
segmentInfo2 optional	String The SegmentInfo1 is used to pass the additional info related to Segmentation. For E-commerce: In this parameter, additional details related to the product Segment can be sent. For Edu Tech: In this parameter, additional details related to the Course Segment can be sent.

","urlObject":{"path":["BroadcastImpression","api","campaign","createUrl"],"host":["www","imprzd","com"],"query":[],"variable":[]}},"response":[{"id":"fa021c35-bd08-482f-808c-22d8fd835dbc","name":"Scenario 1: Sucess Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"merchantId\": \"NTk=\",\r\n \"segmentId\": \"CDT1\",\r\n \"segmentType\": \"new\",\r\n \"username\": \"Rahul\",\r\n \"userId\":\"Student_ID_01\",\r\n \"segmentInfo1\": \"\",\r\n \"segmentInfo2\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"www.imprzd.com/BroadcastImpression/api/campaign/createUrl"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"REQUEST COMPLETED\",\n \"data\": \"https://www.imprzd.com/impressions-web/#/consumer-flow/Q/MzM53r\",\n \"token\": null,\n \"errors\": null\n}"}],"_postman_id":"06db1545-d359-46b7-8f1e-e7453ece5bc6"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b43511db-a05f-4da8-b5f7-d219d59bed6e"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6b451082-bf02-442f-840e-b0c83c03e907"}}],"variable":[{"id":"6a7bcc1e-c8d4-42b6-b939-ec1fadc5c6ac","key":"jwt_token","value":"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJTVBSWkQvQXV0aFNlcnZpY2VzIiwiZXhwIjoxNjg2MTI3MTQyLCJuYW1lIjoiVG9rZW5EYXRhIiwiZGF0YSI6IntcImlkXCI6NjksXCJmaXJzdG5hbWVcIjpcInTDtmhsXCIsXCJlbWFpbGlkXCI6XCJrYXJ0aGlrQGltcHJ6ZC5jb21cIixcInJvbGVcIjoyLFwibWVyY2hhbnRJZFwiOjUxLFwid2Vic2l0ZVwiOlwiaHR0cHM6Ly90b2hsLmluXCIsXCJjYXRlZ29yeVwiOlwiRS1Db21tZXJjZVwiLFwic3ViQ2F0ZWdvcnlcIjpcImJhZ3NcIixcIm1lcmNoYW50TmFtZVwiOlwidG9obFwiLFwibWVyY2hhbnRMb2dvXCI6XCJodHRwczovL3VzLmltcHJ6ZC5jb20vQnJvYWRjYXN0SW1wcmVzc2lvbi9hcGkvZmlsZS9kaXNwbGF5SW1hZ2VWMi9MMmh2YldVdlpXWnpaR0YwWVM4Mk5WOXpaWEoyWlhJdmJXVnlZMmhoYm5STWIyZHZMelV4WDIxbGNtTm9ZVzUwVEc5bmJ5NXdibWNcXHUwMDNkXCIsXCJjYXRlZ29yeUlkXCI6NyxcInN1YkNhdGVnb3J5SWRcIjo2NSxcImVtYWlsXCI6XCJrYXJ0aGlrQGltcHJ6ZC5jb21cIixcImludGVudFwiOlt7XCJpZFwiOjEsXCJ2YWx1ZVwiOlwiQnJhbmRcIn0se1wiaWRcIjoyLFwidmFsdWVcIjpcIkV2ZW50XCJ9LHtcImlkXCI6MyxcInZhbHVlXCI6XCJTZXJ2aWNlXCJ9LHtcImlkXCI6NCxcInZhbHVlXCI6XCJQcm9kdWN0XCJ9XSxcImN1c3RvbWVyVHlwZVwiOlt7XCJpZFwiOjEsXCJ2YWx1ZVwiOlwiQWxsIE15IEN1c3RvbWVyc1wifV19In0.xY51Rh4GGf4kguv2MrUnhrIc4x55vqKWqY-XctCwznQ","type":"string","disabled":true}]}