Skip to main content

API references

OpenAPI definition file​

Our OpenAPI definition file, available in a machine-readable format, provides a detailed description of how to interact with and test our RESTful APIs. You can access the file at the following URL:
https://fx-api.fluentax.com/swagger/v1/swagger.json

This file can be imported into popular API development and testing tools, including Postman, Insomnia, and others. For specific instructions on how to import the OpenAPI (Swagger) file using a URL or JSON file, please consult the documentation for your chosen tool.

Once imported, you can explore the API structure, make test calls, and interact with the various endpoints to evaluate their functionality.

Swagger UI​

You can use our interactive Swagger documentation to browse the available endpoints and to test the API.

Authentication​

  1. Open the Swagger UI page in your web browser.
  2. Locate the Authorize button in the top-right corner of the interface.
  3. Click Authorize to open a dialog displaying the available authorization methods.
  4. Proceed with one of the options below:

Non-interactive (M2M) credentials​

  1. Locate the oauth2 (OAuth2, clientCredentials) authorization method.
  2. Enter your client_id and client_secret credentials recevied from Fluentax.
  3. Click Authorize.
  4. If the Authorize button now displays Logout, authentication was successful.
  5. Close the dialog box to begin testing the API endpoints.
note

Tokens issued via the client credentials flow expire after 5 minutes. If your token has expired, you must re-authenticate. To do this, open the authorization dialog, select Logout and click Authorize again.

Interactive (user) credentials​

  1. Locate the oauth2 (OAuth2, authorizationCode with PKCE) authorization method.
  2. Leave the pre-filled client_id field as is, and click Authorize.
  3. You will be redirected to the Fluentax SSO system to log in.
  4. If the Authorize button now displays Logout, authentication was successful.
  5. Close the dialog box to begin testing the API endpoints.
note

User credentials are available only if you have explicitly requested access to the Fluentax Exchange Rates web application.

Testing API endpoints​

To test an API endpoint:

  1. Click on the desired endpoint and select Try it out.
  2. If required, provide additional request parameters in the fields provided.
  3. Press Execute to call the endpoint.
  4. The server response, including status codes and data, will be displayed below.

Redoc​

You can use our Redoc API reference as a non-interactive alternative to the Swagger UI.