Getting Started‎ > ‎

Create your API Project

You create your API, including connecting to an existing SQL relational database management system (RDBMS), using the connection wizard.

The following image shows the relationship between Live API Creator and your data sources:

Verify Prerequisites

Ensure that you have completed the following prerequisites:

  • You have installed a JDBC driver. To verify that you have a JDBC driver installed, contact your SQL DBA administrator.
Note: The database options you can select when creating your API are dependent on the JDBC drivers you have installed. For more information about installing other JDBC drivers, see Install JDBC DriverIf the database driver is not available or if API Server cannot load it, complete the following:
  1. Provide the JDBC driver.
    For more information about installing a JDBC driver, see Add Other JDBC Drivers.
  2. Restart API Server.
  3. Attempt to connect again.
  • (If you are creating an API with a defined database connection) You have defined the database setting for your active database.

For more information about the active database, see Manage your API Project.

  • You have defined the security setting for the authentication provider.
For more information about admin versus application user, see Security.
  • You have defined your libraries and other API attributes.

Log on to API Creator

You access API Creator using a browser URL, which starts with a logon authentication dialog.

  1. If you have installed the self-contained, single-user version of Live API Creator, which is a demonstration package and based on Jettyenter the following URL in your browser:
    http://localhost:8080/APICreator
    The API Creator logon authentication dialog opens.
  2. Log on as the administrator user (admin). The server location and name depends on the type of installation and configuration of your API.
    The following image shows the API Creator logon authentication dialog:
  3. Complete the following fields and then click Log In:
    Server
    The URL and location of the API Server can include the root WAR name.
    Example: /APIServer
    Note: The value for this field depends
     on your configuration.
    User
    The administrator user. Enter "admin."
    Password
    The administrator password. Enter "Password1."
  4. If this is your first time logging on to API Creator, accept the terms of the End User License Agreement (EULA). You must accept these terms before you can use API Creator.

You are logged on to API Creator. The Welcome Window displays.

Welcome Window

The Welcome Window displays when you first log on to Live API Creator.

Tip! You can go to the Home page and start using API Creator by closing this window (upper right corner).

The following image shows this window and how to close it (upper right corner):

The Welcome Window introduces the following information and topics:

  • A summary of basic concepts and architecture.
  • A link to to the videos, which illustrate key functionality and operations.
For more information about viewing the videos, see Videos.
  • The Tour, which starts automatically when you close this window (upper right). A Welcome Tour is also provided as a video. The Getting Started page summarizes the contents of the video, with links you can explore to get more information about each feature.
For more information:
  • The advanced Business to Business data integration example.
For more information about this example, see Business to Business Example.

Create your API Project

  1. On the Home page, click Create New API. (If the Welcome Window is displayed, close this window.)
    The connection wizard opens. 
    The server loads each of the database drivers to see if they are supported and available. If API Server cannot load the database driver, you cannot select the specific database type.
    The following image shows the connection wizard:
  2. Connect to your database by selecting one of the following:
      • The target database, then complete the following:
        1. Enter the required connection properties that the JDBC driver requires.
        2. (Optional) To test your connection to your SQL database with the URL credentials, click Test Connection. Your new API requires a successful database connection. API Creator reads the schema tables, views, procedures, keys, and relationships and connects the database to API Creator.
        3. Click Continue.
        4. Click one of the following:
        • Proceed to API Properties.
        • Proceed to API REST Lab.
      • Example Northwind database. (Provided in some Live API Creator configurations). This option illustrates how to create an API using a pre-defined database.
      • New empty database. This option creates an API for a new managed database using API Creator and extended in Data Explorer.

    Prerequisite: Your managed data server connection must exist and be active.

    For more information about how to set up a managed database, see Managed Server Administration.

      • JNDI data source. Select this option if your connection information is not stored in API Server's admin database or if you want greater flexibility in leveraging database management system (DBMS)-specific options, such as SSL access and mirroring.
    Note: Firewalls require accommodations.
      • No database. This option creates an API without an initial database connection.
  3. Select Create Sample Rule & Resources to have API Creator discover your tables with relationships to one another, pick the first one, and create a resource tree with a parent and child in one object. API Creator also creates a validation rule that always returns true.
  4. Click Continue.

A default API that matches your schema is created and a connection to the database is created.

You can view detailed connection values for each target database listed in the connection wizard on the following pages:

Next Steps

Now that you have created your API, customize your API by:

  • Taking the API Creator tour.
For more information about this tour, see API Creator Tour.
  • Customizing your API by creating custom REST resources.
For more information, see Manage your API Project.
  • Declaring reactive logic and security.

For more information about declaring reactive logic and security, see Logic.

  • Using stored-procedure resources.
For more information about the automatic resource endpoints per schema discovery, see Use Stored Procedure Resources.
  • Exploring your data using Data Explorer.
For more information about Data Explorer, see Data Explorer.
  • Integrating your API with other systems and databases.