TIBCO Scribe® Online Connector For HTTP

Use the TIBCO Scribe® Online Connector for HTTP to build your own HTTP requests. The flexibility of HTTP allows you to configure Uri, Verb, Query Parameters, Headers, and Content. Content can be hard-coded in a formula or configured with the TIBCO Scribe® Online Connector for Mapper.

Connector Specifications

  Supported
Agent Types
On Premise X
Cloud X
Replication Services
Source  
Target  
Integration Services
Source X
Target X
Migration Services
Source X
Target X
Maps
Integration X
Request-Reply X
Message X

This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Supported Entities

The HTTP Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online. For a list of additional operations by entity see Special Operations.

Special Operations

Entity Operations

HttpMessage

-Wait For Message

GET

POST

PUT

Request

-Send

Cookies

Headers

QueryParameters

-Add

Operation Details

Query, Fetch, and Lookup Blocks display for this Connector but are not supported.

All operations require a URI. Do not include query parameters in the URI, use the Add Block instead.

Wait For Message

The Wait for Message Block only supports the HttpMessage entity. Other entities display in the Block but are not supported.

When sending an inbound message to the HTTP Connector from a third-party system, there are several possible responses that correlate to HTTP status codes, as follows:

Send

Add

The Add Block works in conjunction with the Send Block, allowing you to add one or more Cookies, Headers, or QueryParameters to an HTTP request.

For this Connector, hierarchical relationships are used in http requests to include Cookies, Headers, and Query Parameters as children of the http method selected. Select Cookies, Headers, and Query Parameters on the Block Properties Include tab for the Send Block.

Child information is added using the Add Block Fields tab and is configured as key value pairs.

Setup Considerations

API Usage Limits

Some APIs limit the number of calls you can make. Refer to the documentation for the API you are accessing to determine what the limits are.

Selecting An Agent Type For HTTP

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To HTTP

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
  4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  5. Select OK to save the Connection.

Notes On Entities

Special information about standard entities appears below.

Cookies

Used in an Add Block to add Cookies in the header when sending an HTTP request.

GET

Headers

Used to create a dictionary of Headers using one or more Add Blocks configured with KeyValue pairs. For example, you could send authentication information.

HttpMessage

Used only in the Wait For Message Block in a Message or Request/ Reply Map to receive an inbound message from another system. Use the Send Block to POST or PUT the Contents of the message to a different API. The model of the inbound data is made available to subsequent Blocks in the Content field.

POST

Used to write data to a data source.

PUT

Used to replace existing data.

QueryParameters

Used to create a query string in an HTTP request. Use one or more Add Blocks configured with KeyValue pairs to add parameters. Do not enter ?, &, or other URL encoding. This is handled for you by the Connector. When more than one Query Parameter is used, they are considered ANDs not ORs.

Request

Used to support custom HTTP verbs. Select this entity in a Send Block and use the HttpVerb field on the Fields tab to configure one of the following: 

Note: The HttpVerb field is case sensitive. Entries must be in all capital letters.

Sample Maps

Note: To download the Sample Maps go to the HTTP Sample Maps Knowledge Base article in the TIBCO Community

In TIBCO Scribe® Online, the REST Web Services Connector configures API calls for you based on a Swagger specification, but is limited to RESTful HTTP/API calls. You can use the HTTP Connector to configure customized HTTP/API calls.

These simple Maps attempt to demonstrate some of these concepts and how they can be achieved using the HTTP Connector. Review the Group Block labels in the Maps that explain the purpose of the Blocks inside the Group.

The Creating Requests by HTTP Verb map demonstrates the following: 

The Adding Request Details Map demonstrates the following: 

The Configuring Body with Content type Map provides examples for specific types of content and demonstrates the following:

Note: Best practice is to keep mappings to the Content field very simple. Complex formulas may generate errors. You can use the Mapper and Variables Connectors to create the Content value you want to send.

The Authenticating requests Map demonstrates how to configure authorization and authentication for HTTP web service calls, as follows: 

Warning: Information stored in variables, such as Username and Password, is stored in plain text making the variable values visible to other TIBCO Scribe® Online users.

Some APIs may return more detailed status codes that can be used to modify Map behavior. For example, with an HTTP POST, a 201 code could indicate that the operation created a new record instead of updating an existing record. Review the documentation for the API you are accessing to determine if any of these codes would be useful to you. The Response Status Codes Map demonstrates the following:

The HTTP Message Flow Map demonstrates the following: 

TIBCO Scribe® Online API Considerations

To create connections with theTIBCO Scribe® Online API, the HTTP Connector requires the following information:

Connector Name

HTTP

Connector ID

FB971315-E707-4869-88FA-9A14A5F42AA1

License Agreement

The TIBCO Scribe® Online End User License Agreement for the HTTP Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.