Making Read Endpoints

Configuring a Read Endpoint

To get started with creating a new Endpoint, go to the Data Braider API Endpoints list. Choose the New action. This will open the API Endpoint Card. You need to start with the General information:

1. Code – the unique ID you want to use for this endpoint
2. Description – A note field for you to describe the intended purpose
3. The JSON formatting of the response
4. What type of Endpoint (Read)

1 For the first example, we will make a new endpoint for accessing Vendor information. This will be called the VEND endpoint. For our integration, we will use the Flat style of Output JSON Type. Our resulting endpoint should look like:

2 Now that the Endpoint is defined, we now add which data should be made available in the Endpoint Line section:

3 For each Endpoint, you can specify one or more Tables to pull information from. In this example, we will use only one, the Vendor table. In the Source Table field, click the lookup to locate the Vendor table. This will result in seeing how many possible fields (5) we could choose to include in the data: 4 Once the table has been selected, you must choose which fields to include by choosing the Field action (6):

5 This will open the Field list to select which fields to mark as Included (7):

6 We will select the following fields:

• No.
• Name
• Address
• City
• Phone No.
• Currency Code When you select your fields, and close the Fields window, you should see the correct number of Included Fields (8) for the table:

7 Now, we have a fully configured basic read endpoint. We can preview what our third party will get as a response by selecting the Preview JSON action (9):

8 This will open a new window showing the results of calling the Endpoint:

9