Getting started with QuoteCloud

Authentication, keys and the IDs your calls use

How each route signs in to QuoteCloud, where every ID in a call comes from, and what to ask us before you write code.

Zapier connects to your QuoteCloud account with OAuth when you add QuoteCloud in a Zap, and Make uses its built-in OAuth connection. For your own code, QuoteCloud issues the credential and tells you how to send it: the scheme isn't published. Your calls also use template names, data item placeholders, a price table's Table API Link Id and document numbers.

Last reviewed by the QuoteCloud team

An illustrative server settings file: the QuoteCloud endpoint and credential as placeholders to be supplied by QuoteCloud, a secret shared with your Zap, and the template name and price table ID the calls reuse.

How does each route sign in?

  • Zapier: OAuth

    When you add QuoteCloud to a Zap, Zapier asks you to sign in to your QuoteCloud account and allow access. No key to copy, and you can disconnect it from Zapier.

  • Make: OAuth, bring your own

    Make's built-in OAuth connection signs in to QuoteCloud, then your scenario calls QuoteCloud's API or Zapier endpoints. There's no ready-made QuoteCloud app on Make.

  • Your own code: ask us

    QuoteCloud issues the credential for your account and tells you how to send it. The scheme isn't published, so book a call before you build.

Keep credentials on your server

Whatever credential QuoteCloud gives you, treat it like a password for your account: anyone holding it could create documents in your name.

Keep it in your server's environment or a secrets manager, never in a web page, a mobile app's code or a repository. Give the endpoint that receives events its own secret too.

  • Server-side only: never in browser or app code.
  • Out of source control; in environment settings or a secrets manager.
  • A separate secret for your event endpoint, checked on every request.
Security for API integrations
Your server · settingsTidewell Pavilion Sample code
Illustrative

Server settings

# Illustrative: keep QuoteCloud details on your server only.# .env (never committed, never sent to a browser)QUOTECLOUD_API_URL=<endpoint from QuoteCloud>QUOTECLOUD_CREDENTIAL=<credential issued by QuoteCloud>HOOK_SECRET=<a long random value you also set in your Zap># IDs your calls reuse (from QuoteCloud, see below)QC_TEMPLATE_WEDDING="Wedding reception 2027"QC_TABLE_RECEPTION=reception

Where the IDs come from

// Illustrative: where each value in a create call comes from.{  "template": "<the template's name or ID>",  "dataItems": {    "Event date": "<placeholder copied from Document Data Items>"  },  "tableId": "<Table API Link Id from Pricing Table Settings>",  "documentNumber": "<visible document number, or Copy document ID>",  "imageTarget": "<an image block's API Link ID>"}

Illustrative. QuoteCloud doesn't publish its authentication scheme: ask for the credential and how to send it.

Where does each ID come from?

The values a call needs besides the credential, and where to find them in QuoteCloud.

  • The template

    The template the document starts from. In Zapier you pick it from a list; ask us how your own calls should name it.

  • Data item placeholders

    In the template, open Document Data Items and use Copy to Clipboard beside each item, as the user guide shows.

  • Table API Link Id

    Created in the price table's settings once you turn on API mode, so rows land in the right table.

  • Document number

    Returned when a document is created, and shown in QuoteCloud. In the documents list, Copy document ID copies a document's ID.

  • Image API Link ID

    Set in an image block's settings, such as customer_logo, so Upsert Document Image knows which block to fill.

  • Product SKU or ID

    Find Product matches an exact SKU or product ID; Create Product updates a product when you pass its QuoteCloud product ID.

Set up the template on a trial

Start a free 14-day trial: build the template, its data items and the named price table, then ask us for API access.

What to ask us before you build

QuoteCloud doesn't publish an API reference yet, so these details come from the QuoteCloud team. Ask before you estimate the work, and book a call with your use case in hand.

  • The endpoint and how to send the credential.
  • How a call names the template and the data items.
  • The response, the error format and any rate limits.
  • Whether a test account suits your build, and how trial documents are charged.
  • How your system can hear about events without Zapier, if it needs to.

Get set up in five steps

  1. Choose the plan

    API and Zapier access are on Essentials and up. Start on the free 14-day trial.

  2. Build the template

    Add the data items and turn on API mode in the price table, noting its Table API Link Id.

  3. Ask for access

    Book a call for the endpoint, the credential and the request format for your account.

  4. Store the secrets

    Put the credential in your server's environment or a secrets manager, never in client code.

  5. Test, then go live

    Create a test document, check every data item and row, then point your system at it.

Authentication questions

How do I get a QuoteCloud API key?

Ask the QuoteCloud team. QuoteCloud issues the credential for your account and tells you how to send it with each call; the scheme isn't published. API access is on the Essentials plan and up. For Zapier, you don't need a key: you sign in to QuoteCloud with OAuth when you add it to a Zap.

How does Zapier connect to my QuoteCloud account?

With OAuth. When you add QuoteCloud to a Zap, Zapier asks you to sign in to your QuoteCloud account and allow access, then stores the connection for your Zaps. You can disconnect it in Zapier at any time, and your Zaps stop until you reconnect.

Where do I find a document's ID?

In QuoteCloud's documents list, open a document's actions menu and choose Copy document ID; the user guide says it's used for integrations. Actions such as Send Document take the visible document number, which QuoteCloud returns when the document is created through the API or Zapier.

Can I call the API from a browser or mobile app?

Don't. Make API calls from your own server, where the credential stays private. A credential inside a web page or an app's code can be read by anyone who has it, and used to create documents in your account. Let the browser talk to your server instead.

More API questions

The right credential. The right IDs.

Start a free 14-day trial, build your template, then book a call for API access.