Getting Started
Set up the RoofKit surface that matches the contractor workflow: public visualizer, embeds, attribution, reports, and API handoff.
What these docs cover
RoofKit documentation is organized around the surfaces contractors and implementation partners actually install: Builder, public visualizer links, website embeds, custom domains, lead capture, reports, and Partner API access.
Install paths
Use standalone links, custom domains, button widgets, or inline iframes depending on the contractor website and campaign.
Preselected roof choices
Use deep links to open a visualizer with brand, material, shape, and color already selected.
Operations handoff
Connect leads, attribution, reports, team roles, and API keys without exposing internal admin implementation details.
Recommended first pass
- Create or confirm the contractor workspace and active landing in Builder.
- Choose the public install surface: platform URL, custom domain, button widget, or inline iframe.
- Confirm active roof libraries and catalog values before sharing deep links.
- Verify lead capture and attribution on the final host page, not only in Builder preview.
- Use Partner API docs only when an external system needs authenticated server-to-server access.