Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is the first hands-on exercise to learn about the new Syndeia RESTful Integration capability introduced in Syndeia 3.5.

In this exercise, we will be use the open-source SpaceX Data REST API that provides endpoints to fetch data about SpaceX rockets, launches, ships, starlinksstar links, and other missions.

Objectives

...

  1. Reviewed the content presented in Introduction to REST APIs and Syndeia RESTful Integration

  2. Able to access Syndeia Cloud 3.5 with a valid user account

  3. User account in Syndeia Cloud 3.5 has RESTFUL WRITE permission (contact Syndeia Cloud admin to verify)

Exercise

1/ Login to the Syndeia Cloud Web Dashboard and select the Repositories menu on the menu bar.

...

2/ Point to the RESTful repository type and select the + icon next to it to add a new RESTful repository, as shown in Figure 2 below.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Creating a new RESTful repository in Syndeia implies that you are connecting to an existing enterprise tool or service via its RESTful API.

...

3/ In the Create repository form, specify the following values for the fields.

  • Repository type = RESTful (already selected)

  • URL = https://api.spacexdata.com

  • Name = SpaceX Data

  • Description = SpaceX Data RESTful repository.

  • Authentication Type = None

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

It is helpful to give meaningful names and descriptions to your repositories so that you can easily identify them later. You can use set the name and description fields in the form above to other values.

...

4/ Click on the Create button.

...

5/ You should see the new SpaceX Data repository listed under the RESTful repository type. Select the SpaceX Data repository. It should show up in the Tree View on the RHS.

...

6/ Expand the SpaceX Data repository in the Tree View. It will take a few seconds to initialize and show a default collection named Default RESTful Request Collection when expanded.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

Collections are logical groupings of Requests. You can use them to organize Requests. Think of them as folders except that a Request can be a part of multiple Collections. A default Collection is made available when you add a new RESTful repository.

...

7/ Right-click on the Default RESTful Request Collection (or the SpaceX Data repository) in the Tree View and select Manage RESTful Collections and Requests.

...

8/ The Collections and Requests panel is the single panel to manage all the Collections and Requests for the given RESTful repository. You will use this panel to create, edit, clone, or delete Collections and Requests. This panel contains two tabs: Collections and Requests. The number on each tab shows the number of Collections and Requests that are defined for the given RESTful repository. In the initial state, there is 1 Collection (remember the Default RESTful Request Collection from previous steps) and 0 Requests.

...

9/ Click the Requests tab and then click on the + Add button. You will see an empty form to create a new Request, as shown in Figure 8 below.

...

10/ Click the Requests tab and then click on the + Add button. You will see an empty form to create a new Request, as shown in Figure 8 below.