Libraries and Integrations

From developer's point of view, Flex is simply a set of OpenAPIs - an industry standard describing REST API endpoints. While you could use raw HTTP calls from your platform/language of choice, it is much more convenient to use generated client libraries, which will take care of serialization, deserialization, error handling and other common tasks. This lets you can focus on your core business logic, almost forgetting that you are calling a remote API.

Here is a list of clients we have generated for common languages and platforms:

.NET Clients

• https://www.nuget.org/packages/Xbim.Flex.Client
• https://www.nuget.org/packages/Xbim.Flex.Identity.Client
• https://www.nuget.org/packages/Xbim.Flex.Comms.Client
• https://www.nuget.org/packages/Xbim.Flex.Workflows.Client
• For .NET Core server-side integration see Flex DI Extensions

Angular Clients

• https://www.npmjs.com/package/@xbim/flex-api
• https://www.npmjs.com/package/@xbim/flex-identity-api
• https://www.npmjs.com/package/@xbim/flex-comms-api

Fetch Clients

• https://www.npmjs.com/package/@xbim/flex-react-api
• https://www.npmjs.com/package/@xbim/flex-react-identity-api
• https://www.npmjs.com/package/@xbim/flex-react-comms-api
• https://www.npmjs.com/package/@xbim/flex-react-workflows-api

Ruby Clients

• https://rubygems.org/gems/xbim_aim
• https://rubygems.org/gems/xbim_comms
• https://rubygems.org/gems/xbim_identity

Python Clients

• https://pypi.org/project/xbim-flex/

Dart Clients

• https://pub.dev/packages/xbim_aim
• https://pub.dev/packages/xbim_comms
• https://pub.dev/packages/xbim_identity

Missing a library? Need to build your own?

It's relatively simple to build your own client library from our OpenAPI definitions using a generator tool such as OpenApi-Generator or Swagger CodeGen. Simply point the generator at the relevant Flex OpenAPI definition:

• Flex Identity: https://apis.xbim-dev.net/openapi/definitions/identity-v2
• Flex AIM: https://apis.xbim-dev.net/openapi/definitions/aim-v2
• Flex Comms: https://apis.xbim-dev.net/openapi/definitions/comms-v2
• Flex Flow: https://apis.xbim-dev.net/openapi/definitions/workflows-v2

Typically you will also want to integrate an OAuth2 client into the library supporting the appropriate 'flow'.