Skip to main content

3.7.1 CRUDL APIs

Application data can be exposed via CRUDL API in order to be provided to front end applications or sent to different databases.

Data is exported from an entity. Individual attributes will need to be selected from the entity. Some will require additional definition.

This example will use the Support Tickets Tutorial. It can be adjusted to any entity and attributes. The attributes for this example will be the following: createdBy (which can be defined as a Reference that represents an Object and then select both Name and Email); createdDate; description; title; and ticketStatus (which will be defined as a Reference that represents an Attribute Value and a Value Property defined as Name).

Here are the steps to establish an CRUDL API connection:

1. Create a Technical User.​

  • Go to Config > Technical User.
  • Create a new tab; click +
  • Enter API User
  • Click Finish

2. Establish the CRUDL APIs​

  • Go to Integrations -> CRUDL APIs

  • First, establish the Settings.

    • Create a new tab; click +

    • Set Entity as Ticket

    • Verify that Service Name is set to: Ticket

    • Set Allowed Technical Users to: API User

    • Click Finish

  • Second, establish the API Actions. Click the List radio button. (Note: This introduction will only establish a List; additional methods are available for Read, Create, Update, and Delete functions.) Select the attributes that will be exported to the JSON; click each applicable radio button and click OK on the popup dialog box to approve the way the name will be shown:

    • CreatedDate
    • Description
    • Title

  • Some attributes require additional information:

    • CreatedBy: For Reference Representing, select Object. From the additional options, select both Name and Email
    • TicketStatus: For Reference Representing, select Attribute Value. For Value Property, select Name.

  • In the lower right, click “Enable Client Evaluation Mode for Database Query”

  • Click CTRL + S to save the tab.

3. Establish the API Settings​

  • Save all of the tabs and Release the app.
  • Go to the App Overview.
  • Update the instance you want to connect.
  • Go to instance Settings. Select the API tab.

4. API Tab settings​

API User will be listed with two pieces of important information that will be used to connect to the third-party recipient.

  • In the Actions column, click +_ Generate key. This is the API Key. It will look something like this: 9lCiYDT5SU9EfynBCIC769Vi4Ip7x0Kn

  • In the API Endpoints column, copy the text. This will be added to the URL of the instance: /api/ticket

  • Click Save

5. Establish Complete URL​

On the App Overview, click All Instance URLs. Copy the URL. Add the API Endpoint from Step 4. It will look something like this: https: //e99a2664-4b78-48a7-bfcd-9ad8b3c0d45f.eu.jetveo.io/api/ticket

6. Header Name is jv-api-key​

The header name for Jetveo apps, will always be jv-api-key.

7. Test the API Connection​

Go to the Microsoft Store and download Nightingale. (Note: These instructions are written for Nightingale. You can use any suitable application.)

On the Nightingale home page, enter the information above into the proper places.

  • On the GET line, enter the complete URL. It will look something like this: https: //e99a2664-4b78-48a7-bfcd-9ad8b3c0d45f.eu.jetveo.io/api/ticket

  • Under the Headers tab, enter the header on the first row. It is: jv-api-key.

  • Then enter the Value. It will look something like this: 9lCiYDT5SU9EfynBCIC769Vi4Ip7x0Kn

CRUDL API Settings

Click Send.

Data from the app will be shown in this space.

Here is an example of what the data will look like.

CRUDL API Data

Click Send to update the data or use the drop-down menu to access Send and download.