LogoLogo
No Code Service CreationPowerful Integrated FormsGCloud Information
  • The OneVu Digital Platform
  • Features and Benefits
  • Core Functionality
    • Creating an account
    • Get Answers Fast
    • Submit a Request
    • Track My Requests
    • Profile
      • Changing Contact Details
        • Changing Email
        • Changing Mobile Number
        • Linking to Messenger
        • Linking to WhatsApp
      • Changing Address
      • Changing Name
      • Changing Date of Birth
      • Notification Preferences
      • Citizen Timeline
      • Family and Friends
      • Bookmarked Services
    • MyAccount
    • Two factor authentication
  • đŸŒŠī¸Integrations
    • Introduction
    • Council Tax
      • Civica
      • Northgate
      • Capita
    • Payments
      • Capita Pay360
      • Civica Pay - eStore2
      • GOV.UK Pay
    • Waste
      • Bartec Collective
      • Whitespace Powersuite
      • Yotta Mayrise
      • Yotta Alloy
      • Civica APP (Flare)
    • Housing Rents/Repairs
      • Northgate
    • Benefits
      • Capita
      • Civica
      • Northgate
    • Landlords
      • Capita
      • Civica
      • Northgate
    • Business Rates
      • Capita
      • Civica
      • Northgate
    • Business Improvement Districts
      • Northgate
    • Licensing
      • IDOX Uniform
    • Environmental Health
      • Civica APP (Flare)
    • Concessionary Travel
      • IEG4 Blue Badge
    • Health
      • Digital CHC
    • Notifications
      • GOV.UK Notify
      • Facebook Messenger
      • WhatsApp
    • Fraud & Identity
      • Loqate - Bank validation
      • Xantura - RBV
      • Transunion - RBV
      • TransUnion - ID Verification
    • Maps / Assets
      • Bing Maps
      • Symology
    • Address Look Ups
      • Ordnance Survey - Places API
      • Loqate
    • Bookings
      • Microsoft Bookings
    • OAuth2 - Identity
    • DfE FSM Eligibility Checker
    • DfT Blue Badge
  • đŸ› ī¸OneVu Control
    • Data Silos
      • The basics
      • Content Management - Simple
        • Adding static content
        • Settings
      • Dynamic Content Management
        • Registration
        • Connection Requirements
        • Using back-office data
          • Simple Data Items
          • Arrays of data
          • Data Item Collections
          • Nested Collections
          • Simple Item Formatting
          • Collection Item Formatting
          • Data item calculations
        • High Level Conditions
          • Simple true / false rules
          • Dynamic true/false rules
          • Deeper Dynamic rules
          • AND Conditions
          • OR Conditions
          • NOT Conditions
        • In Section Visibility/Rules
          • If True
          • If Not True
          • If Equal To (v1)
          • If Equal To (v2)
          • If Not Equal To
          • If Greater Than
          • If Less Than
          • If Last
          • If First
          • If Null
          • If Not Null
          • Collections & complex rules
        • Importing a silo
    • Groups
      • Permissions
    • Users
    • Settings - OneVu
    • Account Management
    • Portals
    • Banners
    • Privacy Statements
    • Audit Logs
    • Diagnostics
  • 📞Customer Service Vu
    • Introduction
    • Contact Logging
      • Notes
    • A Single Timeline
    • Set up
      • Service Areas
      • Locations
  • đŸ’ŦBroadcast
    • Introduction
    • Generic notifications
      • Adding From Addresses
      • Adding Email Headers
      • Adding Email Footers
      • GOV.UK Notify Templates
      • Notification Frequency
      • Broadcast Topics
        • Linking - GOV.UK Notify Template
        • Linking - Email Header
        • Linking - Email Footer
        • Linking - SMS Template
      • Broadcast Articles
        • Web Content
        • Plain Text Emails
        • HTML based emails
        • Messages
      • Topic visibility in OneVu
      • Broadcast and CitizenVu
    • eNotifications/eBilling
      • Introduction
      • Functionality
        • Opt In functionality
        • Your Profile
      • Set up
        • Setting up notification types
        • Notification content
          • Notification placeholders
          • Email (Standard)
          • Email (GOV.UK Notify)
          • SMS (GOV.UK Notify)
          • Facebook Messenger
          • WhatsApp
        • Import notification files
          • File Column Mapping
          • Bulky File Import
        • Bulk Export File
      • Notification Audit
      • Contact Management
  • đŸ—ēī¸Your Area
    • Introduction
    • Community Directory
    • Your Issues
  • â˜ī¸OneVu API
    • Introduction
    • Methods
  • 📘My Area Directories
    • Presentation
    • Creating/editing a directory
    • Defining fields in an empty directory
    • Adding records to an empty directory
    • Adding a URL endpoint to an API Directory & Hybrid Directory
    • Importing a CSV file to a Hybrid Directory
    • Importing a CSV file to a Hybrid Directory
    • Configure My Area Directory Display Component
    • Configure My Area Directory Component
    • Configure My Area Directory Component
    • Configure My Area Directory Component
    • Configure My Area Directory Container/Directory Groups component
    • Configure My Area Directory Container/Directory Groups component
    • Configure My Area to display in OneVu
  • ✅OpenProcess
    • Introduction
    • My tasks
    • Supervise Tasks
    • Search Processes
    • Start Process
    • Abandon a Process
    • Process Retention Periods
    • Building Processes
      • Your first process
      • Step Set Up
        • Standard Steps
        • Auto-completing steps
        • Branches
        • REST API Steps
          • Worked example
      • Actions
        • IEG4 Emails
        • GOV.UK Notify Emails
        • GOV.UK Notify SMS
        • WhatsApp Messages
        • Messenger Messages
    • Two-way Communication
    • đŸ› ī¸Set Up
      • Fields
      • Categories
      • Groups
        • Permissions
      • Users
      • Organisations
    • 💾Export to CSV
    • ⚡OpenProcess Flex
      • Cases Functionality
      • Process Branches
        • Nested Branches
        • Multiple Conditions
        • Advanced Conditions
      • Work allocation in branches
      • Choice Fields
      • Mandatory Fields
      • Branches - Search Processes
      • OneVu - Track my Requests
      • Dynamic Notifications
        • Worked Example
      • Worked Example - Simple
      • Worked Example - Advanced
    • 🔀OpenProcess EDMS
      • Document Indexing
        • Multiple Indexing Queues
      • Bulk Document Import
      • Create a Document
      • Set Up
        • Document Types
        • Document Templates
          • Headers
          • Footers
          • Stylesheets
          • Templates Admin/Use
        • Service Areas
        • Account Extracts
          • User Functionality
          • IT Facing Functionality
  • â˜ī¸OpenProcess API
    • Introduction
    • Getting an API Key
    • Methods
    • Webhooks - REST API Steps
  • 📈Reporting
    • OneVu
    • CS Vu
    • OpenProcess
    • Reporting Database
  • 💏Community Content
    • OneVu
      • Council Tax
        • Capita Content
        • Civica Content
        • Northgate Content
        • Sample Demo Content
      • Benefits
        • Capita Content
        • Civica Content
        • Northgate Content
      • Business Rates
        • Capita Content
        • Civica Content
        • Northgate Content
      • Licensing
        • IDOX Uniform Content
      • Housing
        • Northgate Rents Content
        • Northgate Repairs Content
    • eDesigner
    • OpenProcess
      • Council Tax
      • Benefits
      • Business Rates
      • Building Control
      • Adult Social Care
      • Licensing
      • Planning
      • Street Name and Numbering
      • Complaints
      • Housing
      • Waste
      • Environmental Health
      • Streets and Parks
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. OpenProcess API

Getting an API Key

PreviousIntroductionNextMethods

Last updated 3 years ago

Was this helpful?

First, check that you can see this function in your OpenProcess set up screen:

If this is not present and you believe you're licensed to use the APIs, please log a support ticket via

Second, you need to ensure that your user is associated with a group that has the appropriate permission to create an API key, namely:

Api Administrator

Once done you can now create an API key.

Creating an API Key

The List of api keys screen shows an API keys that already exist:

To create a new API key click on the 'Add' button. This will then present the following:

The Name of the API will be shown on any updates made so please be sure to use a name that makes it really clear that the update was API based.

E.g. Chatbot Update, External Form Update, Automated Web hook from Alloy etc.

On pressing save the API key details are displayed.

IMPORTANT

These details are not shown again so be sure to copy these details down and store them somewhere securely. If you lose the details, you should access the list of API key screen and delete the API key you created and create a new one.

You can use these details in the OpenProcess Swagger UI endpoint if you want to test/try them out e.g. test is:

â˜ī¸
help.ieg4.com
Swagger UI
OpenProcess TEST Swagger UI endpoint
API developer access function
List of API Keys
Naming the API key
Logo