Adapter Code For TIBCO API Exchange and Joomla!: User's Guide

Adapter Code for TIBCO API
Exchange and Joomla!

Users Guide
March 2014
| iii
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Adapter Code for TIBCO API Exchange and Joomla! Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Other Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi
Chapter 1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Product Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Role of Application Developers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
What is an API key? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
General Steps for Creating an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Chapter 2 Developing an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Browsing the Featured Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Registering as an API User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Resetting Your Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Browsing the Product Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Exploring a Products API Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Requesting a Product Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Registering an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Browsing the Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Editing an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Using the Application Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Request an Replacement Key for an Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
How to Use the Application Key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Testing API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Building an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
What Is an API Key?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
How Do I Use an API Key in an API Call? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Contacting Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED
iv
| Contents
|v
Preface
Adapter Code for TIBCO API Exchange and Joomla! enables the creation of
Joomla!-based API management portals with TIBCO API Exchange to provide a
highly branded and customizable experience to application developers and API
providers.
Topics
Related Documentation, page vi
vi
| Related Documentation
Related Documentation
This section lists documentation resources you may find useful.
Adapter Code for TIBCO API Exchange and Joomla! Documentation

The document set for Adapter Code for TIBCO API Exchange and Joomla!
includes:
Adapter Code for TIBCO API Exchange and Joomla! Installation
Adapter Code for TIBCO API Exchange and Joomla! User's Guide
Adapter Code for TIBCO API Exchange and Joomla! Administration
Other Product Documentation

You may find it useful to read the documentation for the following:
TIBCO API Exchange Concepts Read this document to get an overview of API
Exchange concepts, workflow, and deployment.
TIBCO API ExchangeSee http://docs.tibco.com.
Joomla!See http://docs.joomla.org.
Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED.
|1
Chapter 1
Overview
This chapter provides a summary of the steps for creating an application using
the API management portal that the Adapter Code for API Exchange and Joomla!
enables.
Topics
Product Overview, page 2
| Chapter 1
Overview
Product Overview
TIBCO API Exchange Manager allows service providers to package and offer
services or APIs to developers inside or outside their company. A self-service
portal allows developers to search and browse available APIs and
documentation, request access, register applications, generate developer keys,
and test API functionality.
Role of Application Developers

As an application developer, you can:
Browse through a product catalogpackages of APIs
Register for an account
Create applications and generate API keys
Request access to offered or custom product plans (subscriptions)
What is an API key?

An API key is used to identify who is calling an API for authorization and tracing
purposes. It's typically passed in through an HTTP header, a URI parameter, or
through an OAuth grant flow.
To generate a ke, a developer registers an application through the portal. The
application typically represents a specific client that is calling or consuming the
API. A client could be a TIBCO BusinessWorks process, a Java-based web app
running in a web server, a JavaScript client running in a browser, or a native
mobile app running on a tablet.
General Steps for Creating an Application

To start using an API, a developer
1. Creates an application through the portal and requests an API key.
2. Requests access to one or more products/plans
3. Tests the API and API key through the API Explorer.
4. Uses the API key in calls to the API from their programming language of
choice
|3
Chapter 2
Developing an Application
As an application developer, you can utilize self-service registration of users,

create applications, explore APIs, and request subscriptions or request additional
keys for applications.
Topics
Getting Started, page 4
Browsing the Product Catalog, page 7
Exploring a Products API Set, page 9
Requesting a Product Plan, page 11
Registering an Application, page 12
Browsing the Applications, page 14
Editing an Application, page 15
Using the Application Dashboard, page 16
Request an Replacement Key for an Application, page 17
How to Use the Application Key, page 18
Testing API Operations, page 19
Building an Application, page 21
Contacting Support, page 22
| Chapter 2
Getting Started
To develop an application using the Management Portal, you create applications,
add products and associated APIs to the application, and request a product key
for the application.
Before you decide to develop an application, the Management Portal allows you
to browse through products that have been created by managers.
To access the Getting Started page for the Management Portal, link to the URL
where the port is installed; for example:
http://<hostname>/index.php
The Getting Started page appears:
Browsing the Featured Products

The Getting Started page presents a list of Featured Products. To browse the
Featured Products:
1. Click the left and right arrows next to the Feature Products list to browse the
products.
2. Click on a featured product to view its product page.
Getting Started 5
The product page for the selected product appears. The following figure
shows the product page for a Book Catalog product.
From the Products page, you can:
View the plans provided for using the product.
Explore the APIs the product provides.
View documentation for the product.
3. To view a product plan, you must sign into the Management Portal. Click the
Sign-in selection in a product plan box.
If you dont have a sign-in, you can request one by registering as an API User.
See Registering as an API User, page 6.
4. To view the APIs associated with the product, click the API Explorer tab.
5. To view the documentation for the product, click the Documentation tab.
| Chapter 2
Registering as an API User

If you dont have a sign-in for the Management Portal, register as an API user:
1. Click the SIGN IN selection at the top of the Getting Started page.
2. Click Create an account.
3. Fill out the form on the New API User Registration page.
4. Check the check box next to I agree to the terms of use.
5. Click REGISTER.
An email is sent to the system administrator requesting an API user account.
Resetting Your Password

From the Getting Started page, you can reset your Management Portal password.
To reset your password:
1. Sign in to the Management Portal.
2. Click on your username, next to the SIGN-ON link at the upper right of the
Getting Started page.
An information page for your User ID appears.
3. Click the tools icon
and from the pull-down menu, choose Edit.
The Edit User Profile page appears.

4. Enter your new password in the Password field and confirm it in the Confirm
password field.
5. Click Save to save the new password.
Browsing the Product Catalog 7
Browsing the Product Catalog

1. Log into the Management Portal.
2. Click the Products tab.
A list of available products appears. Products can be grouped in two ways:
By Reference Data.
By Market Analysis Data.
3. Click on a product.
The product page appears and the Plans tab is active. This tab shows the
existing plans for the product, as shown in the following figure.
4. To request a plan for the product, click REQUEST PLAN in one of the product
plans.
For detailed information on requesting a product plan, see Requesting a
Product Plan, page 11.
5. To explore the APIs available for the product, click the API Explorer tab.
| Chapter 2
For detailed information on exploring the APIs for a product plan, see
Exploring a Products API Set, page 9.
6. To view documentation about the product, click on the Documentation tab.
A description of the product appears, including a description of the API set. A
list of any documents that have been provided for the product also appears.
Exploring a Products API Set 9
Exploring a Products API Set
Known Issue: (ASG-2487)The API Explorer caches the URL, so you can't see new
responses (for negative tests of keys) unless you clear the cache.
To explore the APIs associated with a specified product:

1. Click the Products tab.
2. Select a product in the display of products.
3. Click the API Explorer tab.
4. Enter the API key for the product you want to explore, and from the
pull-down list in the Environment field, choose the environment the product
is in.
Note to reviewers: There is also a field that is supposed to activate a pull-down
menu to list the current applications. This is not working as of today. Can the user
either pull down the application list or enter an application key. At any rate
pasting an application key also has no effect.
If an API for a product is already listed in the API Explorer tab, you can
expand the view of the API to show operations associated with the API by
clicking on the API name.
10
| Chapter 2
The following figure shows the operations for a Books API.
To the right of the API name there is a row of selections that let you explore
the API in more depth:
Show/Hide Click Show/Hide to toggle the display of API operations on
and off.
List Operations Displays a list of operations for the API.
Expand Operations Expands the list of operations and presents an interface
that allows you to test the operations.
For information on testing API operations, see Testing API Operations,
page 19.
Raw Displays the API code as a text file (without formatting).
To view the documentation for the product, click the Documentation tab.
Requesting a Product Plan 11
Requesting a Product Plan

To request a product plan:
1. Go to the Getting Started page.
2. Log into the Management Portal.
3. Click on a product in the list of Featured Products.
A group of product plans appears.
4. To request a plan, click REQUEST PLAN in the plan display.

A dialog appears asking you to confirm the plan and your contact details.
5. Review the information on the confirmation dialog.
6. Check the Agree to the Product-specific terms & conditions check box.
7. If the information for the plan is correct, click PLACE REQUEST.
A subscription request is sent to the host administrator for your organization.
12
| Chapter 2
Registering an Application
Product managers can register applications and assign products to the
applications.
To register an application:
1. Log into the Developer Portal.
2. Click the Applications tab.
3. Click Register Application.
An interface appears for defining the application.
4. Specify the following information to identify the application:
Application name Enter a name for the application.
Icon Optionally, associate an icon with your application by clicking
Choose file, browsing for the file containing the image that you want, and
then clicking Open.
The selected image appears on the configuration interface.
Description Optionally, enter a description for the application.
The bottom of the Register new Application page shows the products that you
can associate with the application.
5. To choose a product:
a. In the list of products, click on the name of a product.
A list of plans that have been enabled for the product appears.
b. To enable a plan, click Use (in the Enabled column).
A checkbox appears in the Enabled column.
If your system administrator has enabled OAuth authentication for your
environment, and you want to use OAuth, click Yes in the OAuth section.
Registering an Application 13
6. If you clicked Yes to specify OAuth authentication, complete these steps to

apply scopes:
a. Click the Set Parent button.
b. From the Attach Existing dialog, select one or more scopes to apply and
then click Apply.
c. In the Redirect URL field, enter a URL that users will be redirected to
when accessing the application.
Users may be prompted to enter a user ID and password to access a partner
service referenced by the redirect URL.
If a label has been associated with the specified URL, the label appears in
the Label field.
d. If no label has been associated with the URL, enter a label.
e. If you want to specify additional redirect URLs and labels, click Add URL
to display additional fields for specifying redirect URLs and labels.
You can specify up to 10 redirect URLs.
7. Click Save to save your application.
An Applications window for your application appears. This window allows you
to request an application key for the application.
When you call an API associated with a product that has been assigned to your
application, you must specify the application key in order to invoke the API.
8. Click the Request Key button.
An application key is generated and appears in the API Key field.
For information on how to use the application key, see How to Use the
Application Key, page 18.
14
| Chapter 2
Browsing the Applications

By clicking the Applications tab, you can browse a list of the current applications
and view the configurations for the applications.
To browse the available applications:
2. A list of the current applications appears.
You can search the list by entering a search string in Search Applications field,
and you can click SORT BY, and then, from the pull-down menu, choose to
sort by Time created, Time Modified, or title.
3. Click an application to view.
If you are the owner of the application, a page appears summarizing details of
the application. From this page you can:
Click the name of a product that includes the application to view the plans
available for the product and application.
Click REQUEST KEY to request a new key for the application.
Click Edit to edit the application
Copy the application key for the application for use on another page.
Click the tools icon
and from the pull-down menu, choose to edit the
application, archive it, or manage version control for the application.
Editing an Application 15
Editing an Application
To edit an application:
1. Sign into the Developer Portal.
3. Choose an application.
The Applications dialog for the application appears.
4. Click Edit.
5. Edit the configuration for the application as required.
For information on the fields for configuring the application, see Registering
an Application, page 12.
16
| Chapter 2
Using the Application Dashboard

The Management Portal provides an application dashboard that allows you to
view:
Quota usage for the applications defined for the installation.
Quota threshold alerts
Information on subscribed products
Statistics (by application or by product?)
Contact information for members of organizations that own applications
To view the dashboard:

1. Click the Dashboard tab.
The Application Dashboard appears.
You can toggle display of the dashboard sections by clicking on the section
title. For example, to toggle display of application quota usage on or off, click
Applications.
2. To view application quota usage, click Applications (if application quota
usage is not already active).
A list of applications with quota usage information appears, as shown in the
following figure.
The bar graph for usage indicates the percent utilization of the usage quota.
If the usage is over its configured threshold the bar is red.
Request an Replacement Key for an Application 17
Request an Replacement Key for an Application

In some situations, you might need to request a replacement key for an
application. This might be necessary if an existing key has been compromised.
When you obtain a replacement key for an application, the original key is
disabled and the replacement key is enabled.
To request a replacement key for an application:
1. Log into the Developer Portal.
3. Click Request Key.
A prompt appears informing you that the existing key will be disabled.
4. To continue with generation of a new key, click OK.
A new key is generated and appears in the API key field.
18
| Chapter 2
How to Use the Application Key

You can use the application key in several areas of the developer portal
interface. You can:
Select the API Explorer and then specify an application key. This brings up a
list of APIs that you can use with your application.
Use the application key in the process of triggering analytics. In order to run
analytics, your installation must be running TIBCO Spotfire, and Spotfire
must be configured correctly.
Testing API Operations 19
Testing API Operations

The API Explorer interface allows you to test operations included in APIs that
comprise your applications.
To test an API operation:
1. Click the Products tab and choose a product.
2. Click the API Explorer tab.
3. Choose an API listed for the product,
4. Click Expand Operations.
The Management portal displays each operation in the API and a dialog that
allows you to enter a test input for the operation. For example, the Books API
includes a GET Books/BookOperations/Author/{Author} operation. The
following figure shows the dialog for the GET
Books/BookOperations/Author/{Author} operation.
To test an operation, enter a value in the input field, and then click Try it out.
20
| Chapter 2
The Management Portal runs the operation and either returns the requested
record or displays an error code.
5. To close the expanded operation display, click on the name of the operation.
For example, to close the display for the Find Book by Author operation, click
on Find Book by Author.
Building an Application 21
Building an Application
Once you have assembled products into an application, you will need to take
certain steps to use the product key in your calls to APIs.
This section provides information on how to use the API key in application
development.
What Is an API Key?

An API key is an opaque token passed as an HTTP header or as a URL parameter
with each request.
How Do I Use an API Key in an API Call?

You specify the API key with the key APIkey or as a query parameter, as shown
in the following example:
https://api.books.co/Books/Now?apikey=195-532d7700-44fe-9175-3a9d4
08a7286
22
| Chapter 2
Contacting Support
To contact customer support for the Developer Portal, click the Support tab, type
a query, and then click the SEND YOUR QUERY button.

Adapter Code For TIBCO API Exchange and Joomla!: User's Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Adapter Code For TIBCO API Exchange and Joomla!: User's Guide

Uploaded by

Copyright:

Available Formats

Adapter Code for TIBCO API

Exchange and Joomla!

Chapter 2 Developing an Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Related Documentation, page vi

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Adapter Code for TIBCO API Exchange and Joomla! Documentation

Adapter Code for TIBCO API Exchange and Joomla! Installation

Adapter Code for TIBCO API Exchange and Joomla! Administration

Other Product Documentation

TIBCO API ExchangeSee http://docs.tibco.com.

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED.

Product Overview, page 2

Role of Application Developers

Browse through a product catalogpackages of APIs

Register for an account

Create applications and generate API keys

Request access to offered or custom product plans (subscriptions)

What is an API key?

General Steps for Creating an Application

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

As an application developer, you can utilize self-service registration of users,

Getting Started, page 4

Browsing the Product Catalog, page 7

Exploring a Products API Set, page 9

Requesting a Product Plan, page 11

Registering an Application, page 12

Browsing the Applications, page 14

Editing an Application, page 15

Using the Application Dashboard, page 16

Request an Replacement Key for an Application, page 17

How to Use the Application Key, page 18

Testing API Operations, page 19

Building an Application, page 21

Contacting Support, page 22

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Browsing the Featured Products

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

From the Products page, you can:

View the plans provided for using the product.

Explore the APIs the product provides.

View documentation for the product.

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Registering as an API User

Resetting Your Password

and from the pull-down menu, choose Edit.

The Edit User Profile page appears.

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Browsing the Product Catalog 7

Browsing the Product Catalog

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Exploring a Products API Set 9

Exploring a Products API Set

To explore the APIs associated with a specified product:

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

The following figure shows the operations for a Books API.

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED

Requesting a Product Plan 11

Requesting a Product Plan

4. To request a plan, click REQUEST PLAN in the plan display.

Copyright 2014 TIBCO Software Inc. ALL RIGHTS RESERVED