The API Reference covers general concepts for working with APIs in the Unqork Module Builder. Components like the Plug-In component and Initializer component use these concepts to send and receive data from external and internal services.
An API (application programming interface) is a connection between systems that lets them exchange data. In Unqork, API calls are typically configured using the Plug-In component. The component sends data from module fields to an external or internal API endpoint, then maps the response back into the module.
A complete API call requires:
- Service: The API endpoint to call—either a built-in Unqork internal service or an external service configured in Services Administration.
- Request Type: The HTTP method that determines what action the API performs.
- Inputs: Module field values sent to the API as parameters.
- Outputs: Response values mapped back into module fields.
HTTP Request Types
The Request Type setting on the Plug-In component sets the HTTP method used for the API call. Each method defines a different intended action on the target resource.
| Request Type | Description |
|---|---|
| GET | Retrieves data from the API without modifying it. Use for read-only operations. |
| POST | Sends data to the API to create a new resource. |
| PUT | Sends data to the API to fully replace an existing resource. |
| PATCH | Sends data to the API to partially update an existing resource. |
| DELETE | Removes a resource from the API. |
Note: The Inputs table is only available when Request Type is set to POST, PATCH, or PUT, because these methods include a request body. GET and DELETE requests do not send a body.
Unqork API Documentation
Unqork exposes its full API through a Swagger interface. Browse all available endpoints, read their documentation, and test calls directly in the browser.
Access the Unqork API Documentation: Navigate to the Unqork environment URL and add /#/apidocs to the end.
An Unqork account is required to access the API documentation. Once logged in, authenticate the session and use the built-in testing tool to make live API calls.
Using the Built-In Testing Tool
Swagger's built-in testing tool lets Creators send real API requests without writing any code. To test an endpoint:
- Navigate to the environment's API documentation (
/#/apidocs) and log in with Unqork credentials. - Find the endpoint to test and click it to expand it.
- Click Try it out.
- Fill in any required parameters using the environment's data.
- Click Execute to send the request.
- Review the response body, status code, and headers returned below.
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |