Getting started as a developer

Learn how to build, integrate and distribute a service on Veracity using platform APIs and developer tools.

Veracity provides the guidelines, tools and support you need to integrate with the platform, deploy your service and manage it throughout its lifecycle.

The onboarding journey combines self-service documentation with technical and commercial meetings facilitated by the onboarding team.

For faster access to documentation and implementation guidance, you can also use the Veracity Development MCP Server, which allows AI assistants to search and apply Veracity documentation directly in your project.

Before you begin

Before starting the developer workflow, ensure that you:

  • have a Veracity account or can create one
  • have access to the Developer portal
  • have a development environment where you can host and test your application

Developer workflow

Building and distributing a service on Veracity typically follows this workflow:

  1. Plan your service
  2. Set up your developer project
  3. Integrate authentication and access management
  4. Integrate platform capabilities
  5. Host your service and integrate APIs
  6. Verify your service for production
  7. Distribute your service on the Veracity Marketplace

Step 1: Plan your service

Plan the full cost of developing and operating your service. Consider infrastructure, development and ongoing operational costs.

Review any third-party APIs or services you intend to use, and ensure they are technically compatible and financially viable.

If you intend to distribute your service on the Veracity Marketplace, review the requirements early in the development process.

Sell your service on Marketplace

Step 2: Set up your project

Create a Veracity account or sign in.

You will need access to the Developer portal to create and manage the resources required for your service.

Once these are in place, you can obtain the credentials required to authenticate your application with the Veracity Identity Provider (IDP).

Related documentation:

Step 3: Integrate authentication

Veracity Identity is the Identity Provider (IDP) for the Veracity platform. It enables secure authentication for users and supports federated access from other companies, providing seamless Single Sign-On.

Veracity Tenant Management (VTM) manages access permissions for applications and associated services. Because users may belong to several tenants, your application must allow them to select the tenant they want to sign in with.

VTM also provides an API for automated access management.

Tip: Use the Veracity Development MCP Server to fetch the right documentation and apply it directly in your project—for example, adding Veracity authentication to a .NET application.

Related documentation:

Step 4: Integrate platform capabilities

The Veracity Data Platform is a secure, cloud-based environment designed for industrial data sharing and digital collaboration.

It supports large data volumes and uses role-based access control to ensure secure and governed data exchange.

A separate onboarding process is required before you can integrate the data platform into your product.

Related documentation:

Step 5: Host your service and integrate APIs

You are responsible for hosting your service.

Integration is typically straightforward for services written in common programming languages and hosted on Azure, Amazon Web Services (AWS) or other major cloud providers.

Veracity API Management (APIM) acts as a secure proxy between your API backend and your customers, simplifying authentication and access control.

Step 6: Verify your service for production

  1. Request verification from the onboarding team once your application meets the technical requirements.
  2. After successful verification, the onboarding team will approve your production version.
  3. Configure your production application using your production credentials.
  4. Request verification of your production environment.

Contact: onboarding@veracity.com

Step 7: Distribute your service on the Veracity Marketplace

Veracity provides a secure and scalable way to distribute digital services without the need to build your own delivery infrastructure.

The Marketplace enables controlled distribution and a consistent access pathway for users.

To prepare your service for distribution, review the Marketplace onboarding requirements and integration guidance.