Getting Started

An overview of features and basic use of the product.
lac31
Use the following process to get started with 
CA Live API Creator
, based on the components: 
  1. Verify the Prerequisites
    Before you get started with
    CA Live API Creator
    , review the videos. These materials give you an introduction to 
    CA Live API Creator
    .
    For more information about the videos, see Videos.
  2. Install an API Server
    API Server operates as a WAR file. You deploy it into standard containers on-premises or in the cloud.
    For more information about how to install an API Server, see Installing and Upgrading.
  3. Log in to API Creator & Get an Overview
    Use the information that is on the Welcome Window in API Creator to get an overview of API Creator.
    For more information about how to log in to API Creator, see Create your API Project.
  4. Create an API
    API Server requires access to your database, whether it be stored in the cloud or within your firewall. Create an API by connecting to a database (or use the Northwind Derby database) or create a database. You can create an API automatically or with control over data access/SQL.
    For more information:
  5. Test your REST API
    Test your API using the REST Lab or Data Explorer. In the REST Lab, you manage and test data directly.
    For more information:
  6. Secure Access to your API
    You secure access to your API using:
    • Authentication.
       Also known as identity management, authentication controls who can see and use your APIs. To facilitate development, you can use the built-in authentication provider.
      For more information about authentication, see Authentication.
    • Role-based access control (RBAC).
       You can secure individual resources and can protect resources, rows, and columns authenticated users can access.
      For more information about how to assign default access for objects for a given role, see Role-Based Endpoint Access.
  7. Specify your business rules
    APIs are the definitions that you create for your data sources, your API (including custom resources), your logic, and your security. Reactive logic enforces your business policy with spreadsheet-like rules. Logic is the rules and JavaScript for event rules, formula rules, and validation rules. Your database design might require changes to support some features, such as sums and counts.
    For more information about how to specify your business rules, see Logic.
  8. Analyze REST Services
    You can see the results of REST calls in the log. The log includes system-generated information (for example, rule and SQL execution) and information you can generate using JavaScript context.
    For more information about how to view logging information, see View Logging Information.