Request Flow

The flow for how requests work and how you should use them

Request API Workflow

1) Create a Request

Keep track of both the id field that Vudy provides (this is the VUDY_ID) and your own vendorId field for your own system.

2) Embed HTML on Your Site

Integrate the provided embed code into your website to display the requested data.

<iframe 
    src="https://vudy.me/embed/request/<VUDY_ID>?dtheme=light&backgroundColor=transparent&primaryColor=%23FF5733&secondaryColor=%238A8A8A&textColor=%23333333&cardBackground=%23FFFFFF&borderColor=%23E5E5E5" 
    width="100%" 
    height="600px" 
    frameborder="0" 
/>

2a. ID Setting

Ensure to insert the specific request ID in the URL is the provided request.id given in the response https://vudy.me/embed/request/{REQUEST_ID}?param=spec

2b. Theme Customization

Customize the appearance using these optional parameters in the search params:

type Theme {
    theme?: "light" | "dark";  
    backgroundColor?: string;
    primaryColor?: string;
    secondaryColor?: string;
    textColor?: string;
    cardBackground?: string;
    borderColor?: string;
}

Colors are preferably set with a hex encoding: #FFAACC or any CSS compatible encoding.

3. Diagram

Here's a basic flow illustrating the API request process:

Notice that confirmation email is provided by Vudy directly. If you want to turn that functionality off, please contact our team