Add Send To RouteAll To Your Order Page
Integration reviewed November 10, 2026 against RouteAll’s partner transfer API, embed script and rep window.
Connecting a permit order page to RouteAll takes one script line on the page and one call from your server. Your server hands RouteAll the permit PDFs for an order; your page opens RouteAll’s window, where your rep checks each state’s route, picks the driver and sends. Keys come from RouteAll when you partner with us.
On This Page
What Are The Pieces?
- Publishable key (
pk_…): sits on your order page and names your company. It cannot send anything. - Secret key (
sk_…): used only by your server to hand RouteAll permits. Shown once, stored by RouteAll only as a hash, and it can be rotated. - Session token: returned for each order, valid for one hour, and good for that order’s window only.
- Allowed origins: the website addresses your window may open on. RouteAll refuses the others.
If you do not want to touch your website at all, skip this page: the RouteAll partner console does the same job with nothing installed.
Step 1: Your Server Hands RouteAll The Permits
When a state issues a permit, your server posts it to RouteAll with your secret key: the order reference, the file name and the PDF, plus the state and permit number if you have them. Post each state as it is issued; permits with the same order reference collect on the same order, up to six. Posting the same PDF again adds nothing.
POST https://routeall.app/api/partner/transfers
Authorization: Bearer sk_…
{ "external_ref": "ORDER-1042",
"file_name": "TX-permit.pdf",
"pdf_base64": "…",
"state": "TX" }The answer is the order’s receipt and a session token for the rep window. Waiting PDFs are held in private storage for 14 days at most.
Step 2: Your Page Opens The RouteAll Window
Add the script to the order page once:
<script src="https://routeall.app/partner/embed.js" data-key="pk_…"></script>Your Send to RouteAll button calls RouteAll.open({ sessionToken }). The window opens over your page as a modal, or as a popup if you prefer. It is served from RouteAll, so your page never handles the driver lookup or the route drawing.
Step 3: Your Rep Checks And Sends
- Each state’s permit opens beside the route RouteAll drew from it. Flagged roads carry an icon. Confirm opens the next state.
- The rep types the driver’s email. RouteAll says only whether the email has an account. Without one, the rep creates it now, or lets the permits wait until the driver signs up.
- Send puts the trip in the driver’s RouteAll, with an email to the driver. Done closes the window and the rep is back on your order.
Step 4: Your Systems Hear The Result
Your page gets a message from RouteAll’s origin when the trip is sent (routeall:transferred), when it is waiting for the driver to sign up, and when the window closes. Your server can also receive a signed transfer.completed webhook, so the order record updates even if the rep closes the tab. The window only posts to your registered origins, and the script accepts messages only from RouteAll.
What Does RouteAll Keep, And What Does Your Desk See?
The PDF and the driver’s email are kept only while the transfer is open. They are deleted when it completes, is withdrawn or reaches 14 days. Your desk sees its own orders and the emails it typed; RouteAll never shows it a driver’s name, plan or other trips. Every lookup and send is logged.
Keys are issued to permit services that partner with RouteAll. RouteAll for permit companies has the walkthrough and the way to reach us.
Before You Go Live
- Your secret key is only on your server, never in page code or a browser.
- Your live website address is on RouteAll’s allowed list.
- Your order page handles all three results: sent, waiting for the driver, closed.
- A rep has sent a test order end to end on the demo page RouteAll sets up for you.
Common Questions
How long does it take to connect an order page to RouteAll?
The page needs one script line with your publishable key, and your server needs one call that posts each permit PDF with your secret key. RouteAll sets up a demo page for your company so your desk can test before going live.
Can we use RouteAll without changing our website?
Yes. The RouteAll partner console lets your desk upload permits for a driver, check each route and send, with nothing to install.
Further Reading
Sources And Scope
Integration facts were checked in RouteAll’s transfer API, embed script and rep window on November 10, 2026. The two web references explain the browser mechanisms the window relies on.
- MDN: Window.postMessage() — How a window on another origin reports results to your page, and why the origin is checked.
- MDN: CSP frame-ancestors — How a site limits which pages may frame it; RouteAll sets it from your allowed origins.
- FHWA Freight Management: Size And Weight — Federal size and weight program; it sends anyone seeking an oversize or overweight movement permit to each state’s permitting contacts.