Skip to main content

Setup your Open API Credentials

Written by Kaitlyn Tredaway

See the steps below to setup your API credentials. This is a feature that is not default for all accounts. Please discuss with your account manager if you do not have access and want to subscribe.

  1. HERE is the postman to generate the access token for your instance.

Current CalcuQuote APIs available for CQ:

Client steps:

  1. Go to Configuration and click on "Integrations"

  2. Click the + button next to "CQ API Applications"

  3. Enter in a name and "Save" in order to Register Application and Initiate API Access. When they create this, they will get a client ID and secret. Be sure to save this - you will need it in a moment!

  4. Click 3 dots next to App Name

  5. Click "Generate Access Token"

  6. Enter Client Password and Secret on next page, Submit

  7. Client ID will be generated on the page under "Client ID" column.

  8. Go to Swagger.

  9. Enter the token you copied from ClientID into the "Authorize" box, make sure the word "Bearer" is in front of the ClientID (Example: 'Bearer eyJhbGciOiJI')

  10. Once authorized, go to desired API category in Swagger, each API has a brief description of what it does.

    1. There are 3 different types of API Requests:

      1. GET: Used to retrieve data from a server.

      2. POST: Used to send data to the server to create a new resource.

      3. PUT: Used to update or replace an existing resource

  11. Enter ClientID into the box and then enter the client code into the "Client Code" box.

  12. Client Code is the going to be the name of the customer's instance.

  13. Click the "Try it out" Button

Resources:

Did this answer your question?