Connection

Connection

Introduction

Connections play a crucial role in enabling communication between our platform and external web applications through plugins and web hooks. This documentation provides guidance on configuring authentication for different connection types.

Supported Authentication Methods

1. API Key

Purpose: API Key authentication allows secure communication by using a key supplied by the external web application.

Configuration Parameters:

  • Token URL: The URL for retrieving the token.
  • Key: The key supplied by the external web application.
  • Client Secret: The client secret from the external web application.
  • Scope: The required scope.
  • Add to: Specifies how to send the parameters.

Example:

Token URL: https://example.com/token
Key: [your-api-key]
Client Secret: [your-client-secret]
Scope: read write
Add to: Query

2. Basic Authorization

Purpose: Basic Authorization uses a username and password for authentication.

Configuration Parameters:

  • User Name: The user name of the external web application.
  • Password: The password for the users of the external web application.

Example:

User Name: [your-username]
Password: [your-password]

3. Bearer Token

Purpose: Bearer Token authentication relies on an access token for secure communication.

Configuration Parameters:

  • Access Token: The token used for authentication.
  • Token URL: The URL to retrieve the token.
  • User Name: The user name of the external web application.
  • Password: The password of the users of the external web application.

Example:

Access Token: [your-access-token]
Token URL: https://example.com/token
User Name: [your-username]
Password: [your-password]

4. OAuth2

Purpose: OAuth2 provides secure authorization through various flows.

Configuration Parameters:

  • Response Type: Authorization Code or Password Credentials.
  • Authentication URL:
  • Token URL: The URL for retrieving the token.
  • Send Token Parameter in: Query, Header, or Body.
  • Client ID:
  • Client Secret:
  • Scope:
  • Prompt:
  • Access Type: Online or Offline.

Example:

Response Type: Authorization Code
Authentication URL: https://example.com/auth
Token URL: https://example.com/token
Send Token Parameter in: Header
Client ID: [your-client-id]
Client Secret: [your-client-secret]
Scope: read write
Prompt: consent
Access Type: Offline

Conclusion

Properly configuring connections with the right authentication method ensures a secure and seamless integration between our platform and external web applications. If you encounter any issues or have questions, feel free to reach out to our support team.


    • Related Articles

    • Quote Integration Status

      Quote integration status allows for syncing between ClaricoQUOTE and ERP system. ClaricoQUOTE provides several quote status options giving users the ability to customize syncing to best suit their quoting process. See below for available status ...

    • Quote Life Cycle

      The provided information outlines the life cycle of a quote, detailing different stages and their corresponding statuses, integration statuses, and sent status. Create a new Quote: QuoteStatus: OPEN-NEW Status: 0 - Entered IntegrationStatus: 0 - ...

    • Web Hooks

      Web Hooks Configuration Documentation Introduction Web hooks in Clarico empower users to invoke external web applications based on specific events. This documentation guides users through the configuration of web hooks, detailing the necessary ...

    • Quote Work Flow

      Setup > Preferences & Costs >Quote Details >Quote Work Flow Sets the work flow steps of a quote Integration The work flow will add a "Submit" status when a quote in won. This allows for external integration to process all the quote that are won and ...

    • Password Authentication

      OAuth Password Authentication, also known as the Resource Owner Password Credentials (ROPC) grant type, allows a client application to request an access token on behalf of a user by directly handling the user's credentials (username and password). ...