• INIES Public API
    • Getting Started
    • Export API
    • Import API
    • API Changes (Breaking Changes + Changelog)

Getting Started

Official resources

  • For subscription, access conditions, and onboarding information, see the INIES resources page:
  • For detailed doc and interactive testing see the INIES Swagger Doc.
  • For client generation, use OpenAPI Specs

Base path

All public endpoints documented here are available under:

/ws/

Authentication

Most endpoints require a bearer token.

  1. Call POST /ws/Login with credentials (email + apiKey).
  2. Use access_token in Authorization: Bearer <token>.
  3. Refresh the token with POST /ws/RefreshToken when needed.

Authentication endpoints

Method Path Description
POST /ws/Login Authenticate and obtain access + refresh tokens.
POST /ws/RefreshToken Refresh access token using refresh token.
POST /ws/Revoke Revoke refresh token (logout-like behavior).

Login example

{
	"email": "john.doe@company.com",
	"apiKey": "ws_live_123456"
}

Token response example

{
	"access_token": "<jwt>",
	"token_type": "Bearer",
	"refresh_token": "<refresh-token>"
}

Refreshing token example

The JWT tokens emitted by the API have a limited lifetime. When the access token expires, you can obtain a new one using the refresh token for 5 minutes after the access token expires. To do this, call POST /ws/RefreshToken with the refresh token.

{
    "refresh_token": "<refresh-token>"
}

Content types

JSON is the default payload format.

Main functional areas

  • Auth: token issuance, refresh, revoke.
  • Export: read standards, nomenclature, units, EPD data, documents. (Note: Read access requires specific permissions. See Official resources for details.)
  • Import: create/update EPDs and manage EPD documents. (Note: Import requires specific write permissions.)
  • HealthCheck: service/database availability check.

Error model

Documented 400/401/404 responses use ProblemDetails. Validation errors (for example 422) use ValidationProblemDetails.

ProblemDetails example

{
	"type": "https://tools.ietf.org/html/rfc9110#section-15",
	"title": "Missing permissions",
	"status": 401,
	"detail": "You do not have read access to products"
}

ValidationProblemDetails example

{
	"type": "https://tools.ietf.org/html/rfc4918#section-11.2",
	"title": "One or more validation errors occurred.",
	"status": 422,
	"errors": {
		"RegNumber": [
			"The RegNumber field is required."
		]
	}
}
In this article
Back to top Generated by DocFX