APIs

Getting data from an API is typically done by sending a HTTP request. This can be done with the HTTP Request module. The HTTP Request module is a generic module that requires the full URL and optional payload and headers. These can either be static or provided as input to the module. The HTTP Request module can convert common data formats, such as JSON, into the internal format used in flows. Basic and Bearer (token) authentication can be used though the Credentials library.

Use the Universal Connector tool

If you use the same API in many flows, it may make sense to create a custom module for this API. You can then build your own connector using the Universal Connector tool. The Universal Connector tool is a wizard-based tool that allows you to parameterize a request using both module settings and flow data. In the end, you will get a new module in your library that looks like any other module including settings, a custom icon, and documentation. This approach makes using an API much easier, since you don't need to remember all the details of the requests. Universal Connectors also supports OAuth credentials.

Define your own API endpoint

You can also define your own 'API endpoint', to allow other HTTP clients publish data into your flows. The flow runtime has a built-in HTTP server and by using the HTTP Listener module you can enable an endpoint on this server. When data is published by an external client you will get an output from this module. If you need to create a custom response, you can combine the Listener module with the HTTP Response module.