REST Services¶

Use the Emakin REST services when an external application needs to authenticate, read or act on work items, initiate processes, trigger events, or evaluate decisions.

Base URL¶

All infrastructure endpoints are exposed under:

1

http(s)://<mydomain>.emakin.com/rest/v1

Authentication Model¶

Infrastructure service calls require an apiKey, issued by a system administrator.

Some endpoints also accept logonId and logonProvider so the caller can act on behalf of a specific user. When Emakin's built-in login system is used, logonProvider is typically Organization. The exact logonId format depends on the provider.

Token-generation endpoints always return tokens within the scope of the registered API key.

Common Request Pattern¶

Most endpoints follow the same structure:

• apiKey identifies the calling system
• logonId and logonProvider supply the runtime user context when required
• endpoint-specific parameters define the operation itself

Endpoint Catalog¶

Authentication and Token Endpoints¶

• GetToken
• GetTokenFromProvider
• GetTokenFromUserInfo

Worklist and Work Item Endpoints¶

• GetWorklist
• GetWorklistCount
• GetWorkItem
• SelectAction
• Worklist Query

Process and Event Endpoints¶

• InitiateByProcess
• Trigger
• Activity Stream

Rule and Script Endpoints¶

• Decision
• ExecuteModule

Choosing the Right Endpoint¶

Use token endpoints when you need authenticated browser or API access. Use worklist endpoints when integrating queues or task actions. Use process and event endpoints when another system needs to start or notify a workflow. Use decision and module endpoints when business logic should be executed remotely.

Related Pages¶

• Integration Services
• Embedding Emakin Forms
• Channel Web Hooks