Create your API

You create your API by connecting to an existing SQL relational database management system (RDBMS).
lac32
You create your API by connecting to an existing SQL relational database management system (RDBMS).
In this article:
 
 
Log in to API Creator
You access API Creator using a browser URL, which starts with a logon authentication dialog.
  1. Enter the URL in your browser:
    • If you have installed the self-contained, single-user version of 
      CA Live API Creator
      , which is a demonstration package and based on Jetty, use a URL similar to the following:
      http://localhost:8080/APICreator
    • If you have a developer or production account, use a URL similar to the following:
      http://<server name>/APICreator/#/
      The API Creator logon authentication dialog opens.
  2. Log in as the administrator user (admin). The server location and name depends on the type of installation and configuration of your API.
  3. Complete the following fields and then click 
    Login
    :
    Server
     
    The URL and location of the API Server, which can include the root WAR name.
    Example:
    /APIServer
    Username
     
    The administrator user account's username. Enter 
    admin
    .
    Password
     
    The administrator user account's 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 in to API Creator. The following image shows the Welcome Window:
welcome_window.png
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 the videos, see Videos.
  • 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 
    CA Live API Creator
     functionality.
    For more information about how to get started with 
    CA Live API Creator
    , see Getting Started.
  • The advanced Business to Business (B2B) data integration sample.
    For more information about the B2B sample, see Business to Business Example.
You can go to the Home page and start using API Creator by closing this window.
Create your API
The following procedure explains how to create your API by connecting to your database.
  1. On the Home page, click 
    Create New API
    . (If the Welcome Window is displayed, close this window.)The connection wizard opens. The following image shows the connection wizard:
      image2017-2-27 22:31:43.png
  2. Connect to your database by selecting one of the following:
    •  
      Example Northwind database.
       This option creates an API using the Northwind sample database.
      The server for the self-contained, single-user version of 
      CA Live API Creator
       based on Jetty is pre-configured for the Northwind sample database. If you have installed this version of 
      CA Live API Creator
      , no additional configuration steps are required to access this database. If you have installed 
      CA Live API Creator
       on another container, such as Apache Tomcat, Oracle WebLogic, or IBM WebSphere, you must configure your server to have access to it.
      For more information:
    •  
      Target database.
       Use this option if you want to create an API for an existing database. Then complete the following:
      1. Enter the required connection properties that the JDBC driver requires.
        For details about the connection values for each target database listed in the connection wizard, including information about how to set up to connect to one of these data sources, see the following:
        The connection wizard displays the database drivers that 
        CA Live API Creator
         supports.
        For more information about the supported drivers, see Supported Platforms.
      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
          .
    • New empty database. 
      This option creates an API for a new database that is automatically created (managed database).
      Prerequisite: 
      Your managed data server connection must exist and be active.
      For more information about how to set up a managed database, see Managed Data Server Administration.
    • Empty API.
       This option creates an API without an initial database connection.
    • JNDI data source.
       Select this option if your connection information is not stored in the 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.
      Firewalls require accommodations.
  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.
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.
  •  
    Defining custom REST resources.
    For more information about how to define custom resources, see Customize your API.
  •  
    Specifying your business logic and security.
    For more information about how to specify your business logic and security, see Logic.
  •  
    Using stored-procedure resources.
    For more information about how to use stored-procedure resources, see Use Stored Procedure Resources.
  •  
    Exploring your data and creating new databases using Data Explorer.
    For more information about how to start and use Data Explorer, see Data Explorer.
  •  
    Integrating your API with other systems and databases.
    For more information about how to integrate systems and data, see Integrate Systems and Data.