Get Started

Prerequisites

  • A web browser (Chrome, Firefox, Safari, etc.)

Accessing the Interface

  1. Open your web browser and navigate to TEDDi

Logging In

  1. On the login page, enter your username and password. Request
  2. Click the “Login” button.

Using the Interface

API Management

After logging in, you’ll be presented with the main interface. This section allows you to manage the available APIs.

Adding an API

  1. Click the “Add API” button.
  2. A form will appear where you can enter the API details:
    • API Name: A descriptive name for the API.
    • API URL: The base URL for the API.
    • Authentication: Select the authentication method (e.g., API Key, Bearer Token, OAuth). Provide the necessary credentials.
    • Other Parameters: Any other required parameters for the API.
  3. Click the “Save” button to add the API.

Removing an API

  1. Locate the API you want to remove in the API list.
  2. Click the “Remove” button next to the API.
  3. Confirm the removal.

API Orchestration

This section allows you to define and execute API workflows.

Selecting APIs

  1. Select the APIs you want to include in your workflow by checking the corresponding boxes.

Defining the Workflow

  1. (If applicable) Use the available tools to define the order and parameters for each API call. This could involve dragging and dropping API blocks, setting input values, or defining conditional logic.

Executing the Workflow

  1. Click the “Run” or “Execute” button to start the API orchestration.

Viewing Results

  1. The results of the API calls will be displayed in a designated area. The format of the results will depend on the APIs used.

Example Workflow

Let’s say you want to use two APIs: “Translate API” and “Sentiment Analysis API.”

  1. You would first add these APIs using the API Management section.
  2. Then, in the API Orchestration section, you would select both APIs.
  3. You might define the workflow so that the output of the “Translate API” (the translated text) is used as the input for the “Sentiment Analysis API.”
  4. After clicking “Run,” you would see the translated text and the sentiment analysis results.

Troubleshooting

  • Login Issues: If you have trouble logging in, ensure you are using the correct username and password. If you’ve forgotten your password, contact your administrator.
  • API Errors: If you encounter errors when running API workflows, check the API details and parameters. Refer to the API documentation for more information.
  • Connectivity Issues: Ensure you have a stable internet connection.