Create an API endpoint for an application

Step-by-Step

1. Open the "Task Management" app.

   Click " ."

   To display the "API Endpoints" section, you must select the "API Endpoints" checkbox under "View" in the main menu Enable the "API Endpoints" view.

   

   You will be taken to the "General" dialog step.

   

2. Enter a name and a description for the endpoint.

   The name must be unique, consist of at least two characters, and begin with a letter. Only alphanumeric characters, hyphens, underscores, and periods are allowed.

   The text captured in the dialogs is incorporated into the Swagger documentation. Therefore, it is very helpful for both you and a potential service provider if you choose descriptive names and follow a naming convention.

3. Click "Data Group Endpoint."

4. Click "Next."

   You will be taken to the "Data Group Selection" dialog step.

5. In the "Action" drop-down menu, select "Read multiple records."

6. In the "Data Group" drop-down menu, select "Team."

   

Step-by-Step

1. Click the " " icon.

   The "Add Data Fields" dialog box appears.

   

2. Uncheck the checkbox "(PK) (S) (ID) <string>"

3. Select the following checkboxes:

   • Description <text>

   • Title <string>

   • Team Leader - Full Name <string>

4. Click "OK."

   You will return to the "Data Group Selection" dialog step.

   The previously selected data fields are displayed in the "Query Return Values" section.

   

   To make the return values and the Swagger documentation easier to read, it is recommended that you rename the return values.

5. In the "Query Return Values" section, select a return value.

6. In the right-hand pane, enter a name and a description for the return value.

   

   In our example, we use "camel case." The first part of the name specifies the application or resource.

   • teamDescription

   • teamTitle

   • teamFullNameTeamLeader

7. Rename all return values.

8. Click "Next."

   This will take you to the "Path Parameters" dialog box.

A path parameter must be specified. We use a static parameter. We use the static path parameter to specify the resource.

Step-by-Step

1. Click the " " icon.

2. Click "Static."

   

3. Enter the name "taskmanagementTeams" and a descriptive name.

   

4. Click "Next."

   You will be taken to the "Query Parameters" dialog step.

In the "Query Parameters" dialog step, no information or queries are required, since we want to identify all teams.

Click "Next."

This takes you to the "Filter and Sort" dialog step.

In the "Filter and Sort" dialog step, we specify how the return values are sorted. It should be based on the team title.

Step-by-Step

1. Click the " " icon.

   

2. Select "Team > Title <string>."

   

   The selected sort order is displayed.

3. Remove any other sorting criteria, if present.

   

4. Click "Finish."

   The newly created endpoint is displayed in the "API Endpoints" section.

5. Click the " " icon (Publish the application in full).

   

In this step, we grant the user David Winter permission to use the endpoint we created earlier.

In the next step, we assign the API key to the user David Winter so that he will have all the necessary permissions to use the API endpoint.

Step-by-Step

1. Open the Properties dialog box for the "Task Management" application.

   To do this, select the application and press "ENTER."

   Or

   Select the application and right-click it.

   Click "Properties" in the context menu.

   The "Properties - Application" dialog box appears.

2. Go to the "Permissions" tab.

3. In the left pane, switch to the "API Endpoints" tab.

   Select the endpoint "/taskmanagementTeams".

   

4. Click "Add."

   This will take you to the "Add Rights Holder" dialog box.

   

5. Select the user "David Winter."

6. Click "OK."

   The user "David Winter" is displayed.

   He has the "Use Endpoint" permission.

   

   Click "OK."

   You will be returned to the application.

7. Click the " " icon (Publish the application in full).

Step-by-Step

1. Launch the "Integration" module.

2. Click "Application API" > "API Keys."

3. Right-click on "API Keys without a role."

   A context menu appears.

4. Click "Create New API Key."

   

   The "Create New API Key" dialog box appears.

   

5. In the "Name" field, enter a descriptive name for the API key.

6. In the "User" drop-down menu, select the user "David Winter."

7. Select the "Task Scheduling" checkbox.

   This automatically enables the API endpoint as well.

   

8. Click "OK."

   The API key entry is displayed under "API Keys Without a Role."

   

Step-by-Step

1. Select the API key you created.

2. Press the right mouse button.

   A context menu appears.

   

3. Click "Copy API Key."

   The API key is now in the clipboard.

   It's a good idea to paste the API key into Notepad, for example.

Step-by-Step

1. Launch the "Integration" module.

2. Click "Application API" > "API Endpoints."

3. Select the application for which you want to create the Swagger documentation.

4. Right-click.

   A context menu appears.

   

5. Click "Create Swagger Documentation."

6. Save the Swagger documentation.

   The Swagger documentation is stored in "yaml" format ("taskmanagement.yml").

Step-by-Step

1. Launch Postman.

2. In the left navigation pane, click the "APIs" menu item.

   

3. Click "Import."

   

   An import dialog box appears.

4. Select the .yml file you saved earlier ("taskmanagement.yml").

5. Click "Import."

   

   A dialog box appears confirming the import.

   The Intrexx API is displayed.

   

Step-by-Step

1. Click the folder with the name of the imported Swagger documentation.

   

2. Click the "Authorization" tab.

3. From the "Type" drop-down list, select "API Key" ().

4. In the "Key" input field, enter the value "X-API-KEY" ().

5. In the "Value" input field, enter the API key you copied from Intrexx (see Step 8 - Copy the API key) ().

6. In the "Add to" drop-down menu, select "Header" ().

7. Save your information.

   

Step-by-Step

1. Click the "Get-all-teams" API endpoint ().

2. On the "Params" tab, disable the query parameter keys (). (The relevant settings are controlled by the Swagger documentation.)

   

3. Click "Send."

   The return values you defined are displayed under "Body."

   

   Display on the "Visualize" tab

   Postman offers the option to display the transmitted JSON data in HTML format via the "Visualize" tab.

   

   To do this, you must enter the appropriate code on the "Tests" tab (). You can find detailed information on this topic at the following link: Postman Learning Center - Visualizing Responses.

   If you then run the request again and switch to the "Visualize" tab (), the data will be displayed as it would appear in an app or a cloud solution.

   

   Below is the code that was used in the "Tests" tab.

   Sample Code

   pm.test("Status code is 200 and Present in Tabular form", function () {
       pm.response.to.have.status(200);
       let template = `
   	<style type="text/css">
           .ixtable {font-size:14px;color:#ffffff;width:100%;border-width: 1px;border-color: #00a3c7;border-collapse: collapse;}
           .ixtable th {color: #ffffff;font-size:16px;background-color:#00a3c7;border-width: 1px;padding: 8px;border-style: solid;border-color: #87ceeb;text-align:left;}
           .ixtable tr {color:#2a2a2a;background-color:#ffffff;}
           .ixtable td {font-size:14px;border-width: 1px;padding: 8px;border-style: solid;border-color: #87ceeb;}
           .ixtable tr:hover {background-color:#e0ffff;}
       </style>
       <div>
           <table class="ixtable" border="1">
               <tr>
                   <th>Name</th>
                   <th>Teamleader</th>
                   <th>Beschreibung</th>
               </tr>
               {{#each .}}
               <tr>
                   <td>{{teamTitle}}</td>
                   <td>{{teamFullNameTeamLeader}}</td>
                   <td>{{teamDescription}}</td>
               </tr>
               {{/each}}
           </table>
       </div>`;
       let response = pm.response.json();
       pm.visualizer.set(template, response.data);
   });