REST API

Article • 29.12.2018 • 1 minute(s) to read

The Novunex Platform provides REST endpoints through which you can programmatically create, read or update Entities and execute Data Queries or start Processes. The Rest API endpoints support JSON responses and will communicate the successful completion of an API request.

Encoded Keys

The XApiKey or the encoded ProcessStartInfo are keys that uniquely identify an authorized API user, authenticate this user, cannot be guessed or forged and can be revoked. These keys are a combination of existing process, subscription and account keys to simplify the url and parameter structure of HTTP REST calls.

Encoded ProcessStartInfo

The encoded process key is needed for the /api/public/process/v2/start/encoded/{processStartInfo} REST call. The {processStartInfo} contains all necessary information (except parameters) to start a process via the API.

  • Key structure (encoded in Base64): AccountGuid:SubscriptionId:SubscriptionKey:ProcessGuid:ProcessAccessKey:SubscriptionUser
  • Sample
    • Decoded: nox1234567890:1:abc21fbc-7fa2-4600-8d50-5abcdefgd3e8c7e:abc4f55c-785a-47d4-9627-66115528bb84:abcd65dc-9985-479c-bfa9-999dfbc1ec04:[email protected]
    • Base64 encoded: bm94MTIzNDU2Nzg5MDoxOmFiYzIxZmJjLTdmYTItNDYwMC04ZDUwLTVhYmNkZWZnZDNlOGM3ZTphYmM0ZjU1Yy03ODVhLTQ3ZDQtOTYyNy02NjExNTUyOGJiODQ6YWJjZDY1ZGMtOTk4NS00NzljLWJmYTktOTk5ZGZiYzFlYzA0OnRlc3QudXNlckB5b3VyZG9tYWluLmNvbQ==
    • Sample url to call a process start: https://yourApi.novunex.app/api/public/process/v2/start/encoded/bm94MTIzNDU2Nzg5MDoxOmFiYzIxZmJjLTdmYTItNDYwMC04ZDUwLTVhYmNkZWZnZDNlOGM3ZTphYmM0ZjU1Yy03ODVhLTQ3ZDQtOTYyNy02NjExNTUyOGJiODQ6YWJjZDY1ZGMtOTk4NS00NzljLWJmYTktOTk5ZGZiYzFlYzA0OnRlc3QudXNlckB5b3VyZG9tYWluLmNvbQ==

General XApiKey

The XApiKey can be used as a url query parameter and contains all keys necessary to access the API.

  • Key structure (encoded in Base64): AccountGuid:SubscriptionId:SubscriptionKey:SubscriptionUser
  • Sample
    • Decoded: nox1234567890:1:abc21fbc-7fa2-4600-8d50-5abcdefgd3e8c7e:[email protected]
    • Base64 encoded: bm94MTIzNDU2Nzg5MDoxOmFiYzIxZmJjLTdmYTItNDYwMC04ZDUwLTVhYmNkZWZnZDNlOGM3ZTphYmM0ZjU1Yy03ODVhLTQ3ZDQtOTYyNy02NjExNTUyOGJiODQ6YWJjZDY1ZGMtOTk4NS00NzljLWJmYTktOTk5ZGZiYzFlYzA0OnRlc3QudXNlckB5b3VyZG9tYWluLmNvbQ==
    • Sample url to call a dataquery: https://your-novunex-url/api/public/dataquery/abcde-6d66-412e-9505-1b0a70584e76/dataresult?xapikey=bm94MTIzNDU2Nzg5MDoxOmFiYzIxZmJjLTdmYTItNDYwMC04ZDUwLTVhYmNkZWZnZDNlOGM3ZTp0ZXN0LnVzZXJAeW91cmRvbWFpbi5jb20=