All docs This doc
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

API creation is the process of linking an existing backend API implementation to the API Publisher so that you can manage and monitor the API's lifecycle, documentation, security, community, and subscriptions. Alternatively, you can provide the API implementation in-line in the API Publisher itself.

Click the following topics for a description of the concepts that you need to know when creating an API:

The steps below shows you how to create a new API.

  1. Log in to the API Publisher.
  2. In the APIS menu, click Add New API.
  3. Select the option to design a new REST API and click Start Creating.
  4. Give the information in the table below and click Add to add the resource.

    Field Sample value
    Name PhoneVerification
    Context 
    /phoneverify

     

    Tip: You can define the API's version as a parameter of its context by adding the {version} into the context. For example, {version}/phoneverify. The API Manager assigns the actual version of the API to the {version} parameter internally. For example, https://localhost:8243/1.0.0/phoneverify. Note that the version appears before the context, allowing you to group your APIs based on the versions.

    Version 1.0.0
    Visibility Public
    ResourcesURL patternCheckPhoneNumber
     Request types

    GET, POST

  5. After you add the resource, click it's GET method to expand it and update the Produces to application/xml and Consumes to application/json. Next, add the following parameters. You use these parameters to invoke the API using our integrated API Console, which is explained in later tutorials. 
    Once done, click Next: Implement > .

    Parameter NameDescriptionParameter TypeData TypeRequired
    PhoneNumberGive the phone number to be validatedQueryStringTrue
    LicenseKeyGive the license key as 0 for testing purposeQueryStringTrue


    Alternatively, click Save to save all the changes made to the API. You can come back later to edit it further by selecting the API and clicking on Edit. For details about the states of the API see Manage the API Lifecycle.

  6. Click the Managed API option.

  7. The Implement tab opens. Enter the information in the table below.

    FieldSample value
    Endpoint typeHTTP/REST endpoint
    Production endpoint

    This sample service has two operations as CheckPhoneNumber and CheckPhoneNumbers. Let's use CheckPhoneNumber here.
    http://ws.cdyne.com/phoneverify/phoneverify.asmx

    To verify the URL, click the Test button next to it.

    Sandbox endpoint

    This sample service has two operations as CheckPhoneNumber and CheckPhoneNumbers. Let's use CheckPhoneNumber here.
    http://ws.cdyne.com/phoneverify/phoneverify.asmx

    To verify the URL, click the Test button next to it.

  8. Click Next: Manage > and enter the information in the table below.

    FieldSample valueDescription
    Subscription TiersSelect allThe API can be available at different levels of service. They allow you to limit the number of successful hits to an API during a given period of time.

  9. Click Save & Publish. This publishes the API that you just created to the API Store so that subscribers can use it.

You have created an API.

You can save partially complete or completed APIs without publishing it. Select the API and click on the Lifecycle tab to manage the API Lifecycle.


  • No labels