apic docs
  • About APIC
  • Installing APIC
  • Getting started with APIC
  • Designer
    • Getting Started With APIC designer
    • Working with API project
    • Creating a Folder
    • Creating a Model or Definitions
    • Creating a Trait
    • Creating an Endpoint
    • Write API Tests starting from Design Phase
    • API Security Definitions
    • Export and view Docs
  • Tester
    • Make an API call
    • Sending Forbidden request headers with APIC
    • Viewing API Response
    • Managing Environments
    • Using Environments
    • Using the Test Builder
    • Writing Test Cases
    • Response Schema validation
    • Creating Test Suites
    • Test Websocket
  • Test Real User Sessions
  • APIC Command line interface (apic-cli)
  • APIC Web Agent (apic-cli)
  • APIC CI/CD Integration (with Jenkins)
  • API Documentation
  • Simulator
  • Dashboard
    • Team Management
    • Published Docs
  • Sharing
Powered by GitBook
On this page

Was this helpful?

APIC Web Agent (apic-cli)

PreviousAPIC Command line interface (apic-cli)NextAPIC CI/CD Integration (with Jenkins)

Last updated 3 years ago

Was this helpful?

One of the best feature of APIC is the option to use the API designer & tester right from your web browser. But using the web version of APIC has one limitation, . By default all web browsers block API requests made to other hosts unless they specify an Access-Control-Allow-Origin header that allows APIC to use the API.

To overcome this limitations we are introducing APIC Web Agent which is part of the . To start using the Web Agent install apic-cli as . Once installed run the following command to start the agent.

apic agent

Once the agent is up successfully you should see below message on the terminal window

By default the agent runs on port 8008. Alternatively you can specify a different post by running

apic agent --port=<your_port>

Connecting to APIC Web Agent from the browser

By default the web app tries to connect to the agent on port 8008. If you can started the agent on a different port then yo need to configure the same in the web application.

To do so open the settings from the header and navigate to APIC Web Agent tab. Here you can configure the port to connect to along with the default request timeout interval.

Once you have opened on your browser you should see below highlight icon in the header. Clicking on the Agent icon should connect to the agent that you started earlier via apic-cli. Now all the API requests you make from APIC will be forwarded to the Agent and once completed the response will be served in APIC. The experience is seamless as if the request was made by the browser itself.

APIC web app
CORS
apic-cli
described here
APIC web agent for CORS