Quickstart

This guide assumes you already have access to the API. If you do not, contact your Conforma representative to receive your base URL and credentials.

1. Check connectivity

Every environment exposes a lightweight liveness probe you can use to confirm that your credentials and network route are working:

curl {{BASE_URL}}/api/v1/health/live

Expected response: 200 OK.

2. Authenticate

For server-to-server work, create a personal access token from the Conforma UI or with the API keys endpoints, then export it in your shell:

export CONFORMA_PAT="cesg_pat_..."

Browser clients can instead use POST /api/v1/auth/login, the ces_session cookie and the CSRF token from GET /api/v1/auth/csrf.

3. Inspect your tenant context

Confirm that the API can identify your user and tenant:

curl {{BASE_URL}}/api/v1/auth/me \
  -H "Authorization: Bearer $CONFORMA_PAT"

To discover scopes that a user can grant to PATs:

curl {{BASE_URL}}/api/v1/auth/api-keys/scopes \
  -H "Authorization: Bearer $CONFORMA_PAT"

See Authentication and API Keys for details.

4. Create your first supplier

1curl -X POST {{BASE_URL}}/api/v1/suppliers \
2  -H "Authorization: Bearer $CONFORMA_PAT" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "name": "Acme Textiles Ltd",
6    "category": "TEXTILES",
7    "country": "IT",
8    "city": "Milano",
9    "contactEmail": "mario@acme.it",
10    "reachCompliant": true
11  }'

On success the server returns 201 Created with the full SupplierDto, including the assigned id (a UUID).

5. List your suppliers

curl "{{BASE_URL}}/api/v1/suppliers?page=1&limit=20" \
  -H "Authorization: Bearer $CONFORMA_PAT"

Returns the suppliers scoped to your tenant. This endpoint is paginated and searchable.

6. Next steps

• Model your data → Core Concepts
• Browse every endpoint → API Reference
• Real-world flows → Examples & Recipes