userguides
  • Welcome
  • Contact Us
  • Getting Started
    • Quickstart
    • Inside ViewZen
  • ViewZen Accounts
    • Overview
    • Account Owner
    • Home Page
    • Member Profile
      • My Account
      • My Organization
      • Security
      • Permissions
    • Roles and Permissions
      • Standard Roles
      • Custom Roles
    • User Management
    • User Groups
    • Multi factor Authentication
    • Context based Permissions
    • API Keys
  • Appverse
    • Overview
    • Home Page
    • Apps
      • Create an App
        • Folders
          • Create
          • Edit
          • Delete
          • View Contents
        • Roles
        • Forms
          • Create
            • Get Familiar
              • General Properties
              • Hint
              • Appearance
              • Validations
                • Examples
              • List of Values
              • Scope
                • Examples
              • Search Settings
              • Security
              • Expressions
              • Appverse Expressions
                • Examples
              • Choices
              • Instance Name
              • Download Form
              • Import Form
            • Best Practices
            • Create with Form Builder
            • Create with GenAI
            • Create with ODK compatible xls
          • Edit
          • Delete
          • Deploy / Undeploy
          • Settings
            • General Settings
            • Data Display
            • Appearance
            • Languages
            • Auto Numbering
            • Lookup
            • Child Forms
            • Report Template
            • Validations
            • Data Formatting Rules
            • Record Access
            • Quick Filters
          • Allocation
            • Get Familiar
              • General Properties
              • View Permissions
          • Quick Configuration
          • Events and Actions
            • Save to DB
            • Lock Record
            • Update Status
            • Create / Update Record
            • Send Notifications
            • Custom Scripts
          • Conditions in Appverse
          • Advanced Search
          • Data
            • Card Layout
            • Grid Layout
            • Master Detail Layout
          • Dashboards
            • Publish Dataset
            • Dashboard
        • Dashboards
          • Link
      • Edit an App
      • Delete an App
      • List of all Apps
      • Publish an App
      • Export & Import an App
    • User Allocation
    • Library
      • Custom Scripts
      • Custom Queries
      • Report Templates
    • Departments
    • Settings
  • ViewZen Analytics
    • Overview
    • Landing Page
    • Dashboard
      • List of Dashboards
      • Create a Dashboard
        • Get Started
        • Datasets
        • Sheets
        • Version Control
        • Toolbar
          • Place Components
            • Properties
              • Data Properties
                • Data Fields
                • Inbuilt Aggregation Functions
                • Dimensions
                • Measures
                • X-axis and Y-axis
                • Column
                • Data Series
              • Format Properties
                • Title / Sub Title / Label
                • Appearance
                • Legend
                • Viewer Settings
                • General Settings
                • Axis Settings
                • Axis Label Settings
                • Axis Title Settings
                • Label Formatting
                • Sorting
                • Color Formatting
                • Column Formatting
                • Stacked Header
                • Footer
                • Actions and Events
                • Chart Settings
                • Grid Settings
                • Data Series Formatting
                  • Value Series
                  • Column Series
                  • Stacked Column Series
                  • Radar Column Series
                  • Waterfall Series
                  • Line Series
                  • Bubble Series
                  • Pie Series
                  • Donut Series
                  • Funnel Series
                  • Clustered Area Series
              • Tooltip Properties
                • Properties
            • Visuals
              • Cards
              • Charts
              • Grid
              • Textbox
              • Filter
              • Image
              • Zone
            • Visuals Marketplace
          • Edit Components
          • Delete Components
        • Filters
          • Fixed Filters
            • Create Filter
              • Filter Conditional Statements
            • Edit Filter
            • Delete Filter
          • Interactive Filters
            • Create Filter
            • Edit Filter
            • Delete Filter
      • Edit a Dashboard
      • Share a Dashboard
      • Delete a Dashboard
      • View a Dashboard
      • Use Dashboard for Presentations
Powered by GitBook
On this page
  • Key Features
  • Permissions
  1. ViewZen Accounts

API Keys

PreviousContext based PermissionsNextOverview

Last updated 4 months ago

API Keys in ViewZen provide secure access to the platform’s resources across products, enabling seamless integration with external applications. These keys act as authentication tokens that allow developers to interact with ViewZen APIs without requiring manual login credentials.

Key Features

  • Secure Authentication – Ensures only authorized users and systems can access ViewZen resources. Once an API key is generated and provided, it cannot be viewed or retrieved again.

  • Permission-Based Access – API keys can have different permissions, limiting access to specific resource and to specific types of access (i.e., create, view, edit and delete).

  • Easy Integration – Enables third-party applications, custom portals, and other applications to connect with the ViewZen platform.

  • Revocation – Users can disable keys to maintain security.

  • Expiry Date - An expiry date an be set for any key.

Permissions

API Keys can be provided Create, View, Edit and Delete Permissions on the following resources

Product / Application
Resource

ViewZen Accounts

Tenant, Usergroups, Users

Appverse

Forms, Form Allocation, Form Data and Form Library

ViewZen Analytics

Connectors, Dashbaords, Datasets, Pipelines

Lost the API Key

If you lose your API key, it cannot be recovered. In such cases, disable the lost key and generate a new one to use..

Purpose driven API Keys

Create separate API Keys for specific purposes. Always limit permissions to restrict access to intended purposes alone.

API Keys