Getting Started for API Developers

Learn how to add an API and test it.

API Platform Version: 8.1 and later

Table of Contents

  1. Step 1: Sign up
  2. Step 2A: Add an API from an API description document
  3. Step 2B: Add an API from scratch
  4. Step 3: Test your API
  5. Step 4: What's next?
  6. Tutorial Videos

The Akana API Platform brings API providers and App developers together. It provides easy access to powerful API management capabilities, combined with a social community that allows developers to collaborate, building innovative Apps with scalable APIs.

Let’s get going.

Step 1: Sign up

Sign up for an account if you don’t already have one. You can register locally, or use your favorite social networking account. From the home page, click Sign Up.

Step 2A: Add an API from an API description document

When you add an API from a Swagger, RAML, WADL, or WSDL document, the platform creates the API, uses the information to add the API design, and creates the Live implementation. You'll then need to review the implementation and modify as needed, add another implementation if you want another, and test.

To add an API using an API description document
  1. Log in to the Akana API Platform.
  2. Click the plus sign (+) in the middle of the top menu bar, and choose Add a New API.
  3. Choose Add a new API, and then click the I have a Swagger/RAML/WSDL/WADL document button. There are two ways you can provide the API definition:
    • URL: Provide the full URL, including protocol. If the URL requires authentication, provide your username and password.

      Note: Depending on the platform settings, you might not be able to upload from a URL that isn't trusted. If you see an error message or a 403 Forbidden response, contact the Site Admin, who can add the URL to the trusted list. See Limit forward proxy feature to allow only these hosts (Site Admin help).

    • File: Browse to the location of the file and upload. If the file includes multiple services, you'll be shown a list of options for the service to import; choose the one you want.
  4. Click Save. The API is created, and the API's Overview page is displayed.

When you create an API from an API description document, the platform automatically creates a Live implementation. Optionally, you can add a Sandbox implementation. For information about implementations, see Manage API Implementations.

When you're done, remember to test your API, using Test Client, to make sure it's working properly. See API Testing with Test Client.

Add an API from scratch

If you want to enter all the values by hand, choose this option.

To add an API by designing from scratch
  1. Log in to the Akana API Platform.
  2. Click the plus sign (+) in the middle of the top menu bar, and choose Add a New API.
  3. Choose Add a new API and click Add.
  4. Click the I want to design my API from scratch (REST only) button.
  5. Provide a name for the API, and the endpoint if you have it already.
  6. Click Save. The platform saves the data and takes you to the API Designer for adding details about your API, including:
  7. When done, remember to click Save on the API Designer window, to save your API design.

Step 3: Test your API

Ok, so you’ve added an API. At this point you should probably make sure it works before you go too much further. To test your API you’ll need to create an App, connect to your API and send some test messages. See the App Developer getting started guide for help.

Step 4: What's next?

Ok, you’ve created and tested your API. You’re good to go, but there are a few more things you should do to help developers make the most of it. You should consider things like: documentation, legal agreements, OAuth, API privacy and group management, monitoring, and versioning.

Back to top

Tutorial Videos

You can review the tutorial videos below to get an overview of the user interface and the activities associated with API management. These videos use simple examples to illustrate API management activities.

All these videos are published on YouTube, unless otherwise noted. More will be added in the future.

Back to top