Skip to main content
Skip table of contents

Veeva Connector v1.0

1. General Information

Veeva Vault is a cloud-based enterprise content management (ECM) platform designed specifically for the life sciences industry. It provides a suite of applications to manage documents and data across various functions, such as clinical, regulatory, quality, and commercial.

image-20240730-082557.png

After login you will be the dashboard like below.

image-20240730-082410.png

2. Authentication

a. Getting sessionId

Veeva uses sessions to authenticate apis. To get a sessionId we need to send POST request to

CODE
$ curl -X POST https://myvault.veevavault.com/api/v24.1/auth \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json" \
-d "username={username}&password={password}"

Below is the response received when request is sent to above call

CODE
{
    "responseStatus": "SUCCESS",
    "sessionId": "5247B157A4DBBDCFC1DE43265184CDA2F2ECB6D2CCA60BE47699D69FB7DBD9EB61FD28A9462C79A5E34A3C90715F949250C38E29425DB21E691BCF6CBD4C3D75",
    "userId": 17063069,
    "vaultIds": [
        {
            "id": 169741,
            "name": "Risetime-PromoMats",
            "url": "https://partnersi-risetime-promomats.veevavault.com/api"
        }
    ],
    "vaultId": 169741
}

b. Using sessionId and Session Validity

Previously obtained sessionId is used in Authorization headers of subsequent API calls.

A session is considered “active” as long as some activity (either through the UI or API) happens within the maximum inactive session duration. This maximum inactive session duration varies by Vault, and is configured by your Vault Admin. For example, a Vault configured with a session duration of 10 minutes means a session will expire 10 minutes after the last API request finishes executing. As long as an API request is active, the session that made that API call will continue to be valid until the request finishes executing.

3. Connector Actions and Tests

a. Create a Task

Action Name / Method

Users: Retrieve Current User with SCIM (GET)

Action Description

This action retrieves data about current user using sessionId.

Test Case

This action is used to retrieve data about current user.

Request Body Name

Paramenter

 

Version

required

 

image-20240730-102013.png

 

4. Connection Settings and Configuration

 

Settings Parameters

Value

Description

Required (Y/N)

Default Value

Connector

OTCS

Connector Name

Y

OTCS

Host Name

Endpoint required for performing CRUD

Y

Authentication

Bearer

Type of authentication

Y

 

Token

{sessionId}

sessionId

Y

 

image-20250101-212323.png

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.