VC Publisher API

curl https://{publisherUrl}/api/v1/logout \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { getLogout } from '@vcsuite/publisher-sdk';

const response = await getLogout();

curl -X POST https://{publisherUrl}/api/v1/project \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mein Beispielprojekt",
    "description": "Ein Projekt zur Demonstration der API",
    "bbox": [-180, -85, 180, 85]
  }'

import { postProject } from '@vcsuite/publisher-sdk';

const response = await postProject(
  {
    // optional managerId
  },
  {
    name: 'My Example Project',
    description: 'A project for demonstrating the API',
    bbox: [-180, -85, 180, 85]
  }
);

curl https://{publisherUrl}/api/v1/project/{projectId} \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { getProject } from '@vcsuite/publisher-sdk';

const project = await getProject({ projectId });

curl https://{publisherUrl}/api/v1/projects \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { getProjects } from '@vcsuite/publisher-sdk';

const projects = await getProjects({});

curl https://{publisherUrl}/api/v1/users \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { getUsers } from '@vcsuite/publisher-sdk';

const users = await getUsers({});

curl https://{publisherUrl}/api/v1/user-profiles \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { getUserProfiles } from '@vcsuite/publisher-sdk';

const userProfiles = await getUserProfiles({});

curl https://{publisherUrl}/api/v1/iam/roles \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { getIamRoles } from '@vcsuite/publisher-sdk';

const roles = await getIamRoles({});

curl -X PUT https://{publisherUrl}/api/v1/project/{projectId}/user/{userId} \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{ "roleId": "<role-id-aus-schritt-2>" }'

import { putProjectUser } from '@vcsuite/publisher-sdk';

await putProjectUser({ projectId, userId }, { roleId: '<role-id-aus-schritt-2>' });

curl https://{publisherUrl}/api/v1/project/{projectId}/users \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { getProjectUsers } from '@vcsuite/publisher-sdk';

const users = await getProjectUsers({ projectId });

curl -X DELETE https://{publisherUrl}/api/v1/project/{projectId}/user/{userId} \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..."

import { deleteProjectUser } from '@vcsuite/publisher-sdk';

await deleteProjectUser({ projectId, userId });

curl -X POST https://{publisherUrl}/api/v1/project/{projectId}/task \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{
    "labels": [],
    "tags": {},
    "debugLevel": 2,
    "priority": 1,
    "name": "Test_api_task",
    "description": "task with api settings",
    "parameters": {
      ...
    },
    "properties": {},
    "jobType": "vcTilesVector",
    "jobVersion": "",
    "schedule": { "type": "immediate" }
  }'

import { postProjectTask } from '@vcsuite/publisher-sdk';

const response = await postProjectTask({ projectId }, {
  labels: [],
  tags: {},
  debugLevel: 2,
  priority: 1,
  name: 'Test_api_task',
  description: 'task with api settings',
  parameters: {
    datasource: { command: 'create', name: 'Vector_Test' },
    options: {
      input: {
        dataSource: {
          '@type': 'GeoJSONSource',
          fileSet: [{ dir: 'C:\\path\\to\\input\\data', fileName: [{ name: '*.json' }] }],
          extrudeInfo: { extrudePoints: false, extrudeLines: false, extrudePolygons: false, heightPropertyName: '', defaultExtrudedHeight: 0 },
          defaultColor: { '@type': 'ColorSymbol', value: '#cccccc' }
        },
        heightMode: { type: 'absolute', offset: 0 }
      },
      modelOptions: {
        defaultShininess: 0.2,
        defaultCreaseAngle: 10,
        renderPrimitiveOutlines: { value: false, color: '#000000', outlineMode: 'Surfaces', polygonArray: true }
      },
      tiling: {
        geometricErrorComputationStrategy: { '@type': 'GeometricErrorComputationRelativeToTileSizeStrategy', geometricErrorToTileSizeRatio: 0.0115866254 },
        value: {
          '@type': 'SingleLevelTiling',
          spatialSubdivisionSchema: { '@type': 'QuadtreeSubdivision' },
          fixedGeneralization: { '@type': 'FixedGeneralization', tolerance: 0, texelSize: 0 },
          fixedObjectSizeFilter: { '@type': 'FixedObjectSizeFilter', thresholdValue: 0 },
          tileLevel: 15
        },
        featureSelectionMode: 'containsCenter'
      },
      processing: { convertMaterialsToTextures: false },
      output: {
        tiles3D_1_1: {
          layerJson: { maxLevelsInTileset: 3, prettyPrint: true },
          gltfOptions: {
            exportMetadata: true, addSubfeaturesIndicator: true, backFaceCulling: true,
            transparencyMode: 'combined', alphaFilterThreshold: 0.8, metallicFactor: 0,
            minFilter: 'linear', magFilter: 'linear', prettyPrint: true, reverseFeatureIdLabels: true,
            srgbValuesInPbrBaseColorFactor: false, usePrimitiveOutlineExtension: true,
            useMaterialsUnlitExtension: false, useUnsignedShortIndexAccessors: false,
            imageEncoding: 'jpeg_png',
            jpegOptions: { jpegCompressionQuality: 0.8, jpegChromaSubsampling: '4_2_2' },
            pngOptions: { pngCompressionQuality: 0.5 }
          }
        }
      }
    }
  },
  properties: {},
  jobType: 'vcTilesVector',
  jobVersion: '',
  schedule: { type: 'immediate' }
});

curl -X POST https://{publisherUrl}/api/v1/project/{projectId}/data-bucket \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Mein eigener Bucket" }'

import { postProjectDataBucket } from '@vcsuite/publisher-sdk';

const bucket = await postProjectDataBucket({ projectId }, { name: 'Mein eigener Bucket' });

curl -X POST https://{publisherUrl}/api/v1/project/{projectId}/datasource \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Name der Datenquelle",
    "type": "geojson",
    "typeProperties": {
      "screenSpaceError": 16
    },
    "sourceProperties": {
      "type": "internal",
      "dataBucketId": "{dataBucketId}",
      "dataBucketKey": "pfad/zur/hochgeladenen/datei.json"
    }
  }'

import { postProjectDatasource } from '@vcsuite/publisher-sdk';

const datasource = await postProjectDatasource({ projectId }, {
  name: 'Name der Datenquelle',
  type: 'geojson',
  typeProperties: { screenSpaceError: 16 },
  sourceProperties: {
    type: 'internal',
    dataBucketId: dataBucketId,
    dataBucketKey: 'pfad/zur/hochgeladenen/datei.json'
  }
});

curl -X POST https://{publisherUrl}/api/v1/project/{projectId}/datasource \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Name der Datenquelle",
    "type": "wms",
    "typeProperties": {
      "layers": ["layer_name"],
      "version": "1.3.0",
      "format": "image/png"
    },
    "sourceProperties": {
      "type": "external",
      "url": "https://example.com/wms"
    }
  }'

import { postProjectDatasource } from '@vcsuite/publisher-sdk';

const datasource = await postProjectDatasource({ projectId }, {
  name: 'Name der Datenquelle',
  type: 'wms',
  typeProperties: {
    layers: ['layer_name'],
    version: '1.3.0',
    format: 'image/png'
  },
  sourceProperties: {
    type: 'external',
    url: 'https://example.com/wms'
  }
});

curl -X POST https://{publisherUrl}/api/v1/project/{projectId}/app \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Meine Stadt-App",
    "description": "Öffentlich zugängliche 3D-Stadt-App",
    "mapVersion": "^6.0.0",
    "moduleIds": ["module-id-abc"]
  }'

import { postProjectApp } from '@vcsuite/publisher-sdk';

const response = await postProjectApp({ projectId }, {
  name: 'Meine Stadt-App',
  description: 'Öffentlich zugängliche 3D-Stadt-App',
  mapVersion: '^6.0.0',
  moduleIds: ['module-id-abc']
});

curl -X POST https://{publisherUrl}/api/v1/project/{projectId}/module \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mein Basismodul",
    "description": "Beschreibung meines Basismoduls",
    "properties": {},
    "layers": [
      {
        "type": "OpenStreetMapLayer",
        "name": "OpenStreetMapLayer(1)",
        "properties": {
          "attributions": {
            "provider": "OpenStreetMap contributors",
            "url": "http://www.openstreetmap.org/",
            "year": "2026"
          }
        },
        "activeOnStartup": true,
        "zIndex": 0
      },
      {
        "type": "GeoJSONLayer",
        "name": "test_api_datasource",
        "activeOnStartup": true,
        "url": "./datasource-data/f4a59d97-4401-45ab-b31a-2e5ad6569fc9/testLake3_withZ.json",
        "extent": {
          "coordinates": [12.278030916360558, 53.76142514632812, 12.32886225819537, 53.778920631506764],
          "projection": { "type": "Projection", "epsg": "EPSG:4326" },
          "type": "Extent"
        },
        "datasourceId": "f4a59d97-4401-45ab-b31a-2e5ad6569fc9",
        "zIndex": 0
      }
    ],
    "maps": [{ "type": "CesiumMap", "name": "CesiumMap" }],
    "contentTree": [
      {
        "type": "LayerContentTreeItem",
        "name": "OpenStreetMapLayer(1)",
        "layerName": "OpenStreetMapLayer(1)"
      }
    ],
    "startingMapName": "CesiumMap"
  }'

import { postProjectModule } from '@vcsuite/publisher-sdk';

const response = await postProjectModule({ projectId }, {
  name: 'Mein Basismodul',
  description: 'Beschreibung meines Basismoduls',
  properties: {},
  layers: [
    {
      type: 'OpenStreetMapLayer',
      name: 'OpenStreetMapLayer(1)',
      properties: {
        attributions: {
          provider: 'OpenStreetMap contributors',
          url: 'http://www.openstreetmap.org/',
          year: '2026'
        }
      },
      activeOnStartup: true,
      zIndex: 0
    },
    {
      type: 'GeoJSONLayer',
      name: 'test_api_datasource',
      activeOnStartup: true,
      url: './datasource-data/f4a59d97-4401-45ab-b31a-2e5ad6569fc9/testLake3_withZ.json',
      extent: {
        coordinates: [12.278030916360558, 53.76142514632812, 12.32886225819537, 53.778920631506764],
        projection: { type: 'Projection', epsg: 'EPSG:4326' },
        type: 'Extent'
      },
      datasourceId: 'f4a59d97-4401-45ab-b31a-2e5ad6569fc9',
      zIndex: 0
    }
  ],
  maps: [{ type: 'CesiumMap', name: 'CesiumMap' }],
  contentTree: [{ type: 'LayerContentTreeItem', name: 'OpenStreetMapLayer(1)', layerName: 'OpenStreetMapLayer(1)' }],
  startingMapName: 'CesiumMap'
});

curl -X PUT https://{publisherUrl}/api/v1/project/{projectId}/app/{appId} \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6..." \
  -H "Content-Type: application/json" \
  -d '{
    "moduleIds": ["module-id-abc", "module-id-second"]
  }'

import { putProjectApp } from '@vcsuite/publisher-sdk';

await putProjectApp({ projectId, appId }, {
  moduleIds: ['module-id-abc', 'module-id-second']
});