Test the API with Postman

Try the API before you build anything. QuoteCloud gives you test credentials that last a day, and a request you can paste straight into Postman to create a document.

Before you start

You need the API & Zapier add-on on your company, access to your organisation’s settings, and Postman or any other tool that sends web requests. Test credentials act as you, in the company you’re working in, so anything you create is yours.

  1. Open API Testing

    Open the API dashboard, choose Manage Integrations at the top right, then the API Testing tab.

    The API Testing tab in Manage Integrations, with the tab and the Generate Credentials button outlined.Open full size in a new tab

  2. Generate credentials

    Choose Generate Credentials. You get a Client ID and an Access Token, which last 24 hours. They’re hidden on screen, but the copy buttons copy the whole value. QuoteCloud also adds a client called API Test Client to your OAuth Clients, and uses it again next time.

    Test Credentials Generated, showing a hidden Client ID and Access Token with their copy buttons outlined.Open full size in a new tab

  3. Set up the request in Postman

    Below your credentials, Postman Configuration has everything to copy. The picture comes from a test server: on your account, the address starts with https://app.quote.cloud.

    Postman Configuration, showing the Create Document address, the Authorization and Content-Type headers, and a sample request body, with each copy button outlined.Open full size in a new tab
    Address
    In a new Postman request, set the method to POST and paste the endpoint. Keep the client_id on the end, because the API turns the request away without it.
    Headers
    On the Headers tab, add Authorization with the copied value, which starts with Bearer, and Content-Type set to application/json.
    Body
    On the Body tab, choose raw and JSON, then paste the sample. Change quotecloudEmailAddress to the email you sign in with.

  4. Send it

    Choose Send. You should get a 200 reply like this one, which is shortened here, and a new draft called Test Document on your dashboard. The request also shows in the API dashboard’s Events table, with a down arrow.

    Reply
    {
  "data": {
    "message": "Document created",
    "status": "success",
    "zapierDocument": [
      {
        "documentId": 39,
        "documentTitle": "Test Document",
        "documentOwner": "you@yourcompany.com",
        "deliveryStatus": "draft",
        "editUrl": "https://app.quote.cloud/en/editor/…"
      }
    ]
  }
}

Try other endpoints

Every endpoint in this reference works the same way: send the Authorization header and add client_id to the address. A simple one to start with is List document status options. Here’s the same request as above from a terminal:

curl
curl -X POST "https://app.quote.cloud/api/v1/createDocument?client_id=YOUR_CLIENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"quotecloudEmailAddress": "you@yourcompany.com", "title": "Test Document"}'

If it doesn’t work

401 unauthorized
The token is missing, mistyped, revoked or more than 24 hours old, or the address has no client_id. Generate new credentials and copy them again.
403 addon_required
The company doesn’t have the API & Zapier add-on. Turn it on.
403 insufficient_scope
These credentials aren’t allowed to do that. Generate new ones.
403 usage_limit_reached
Your plan has used its API documents for this billing period.
429
More than 120 requests in a minute from your account. The reply says how many seconds to wait.

When you’re finished

Choose Revoke Token to stop the token working straight away. Test credentials are for trying things out. For a real connection, create an OAuth client.