JobConfig Listener Aliasing
Note: You must be an Account Admin User to create, modify, or manage Aliasing.
For better integration with external apps, any JobConfig Listener can be aliased to create a custom URL for your clients to execute your integration:
• Clients do not have to keep track of job config IDs to use it.
• You can swap the backend job config without disrupting clients .
• You can create multiple aliases for the same job config.
• You can create, distribute, and manage API key(s) to authorize your Alias.
As an example, you can turn this:
POST /api/jobconfigs/79356/listener?messagename=msg1 HTTP/1.1 Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.
eyJzY29wZXMiOlsiUk9MRV9BRE1JTiIsIlJPTEVfVVNFUiJdLCJpZCI6MSwiYWNjb3VudCI6MSwic Content-Type: application/json
{
"name": "value",
"metric": 124
}
into this:
POST /api/listener/my-custom-job-url HTTP/1.1
Authorization: Basic sIlJPTEVfVVNFUiJdLCJpZCI6MSwiYWNjb3VudCI6MSwi
Content-Type: application/json
{
"name": "value",
"metric": 124
}
API Details
• Synchronous:
– Text Message payload 200 OK response (response body is driven by your integration process using outmessagename)
– Text Message payload 408 Timeout response:
• Your integration process does not complete within 30 seconds
• Result/output may be retrieved asynchronously after the job is complete
• Asynchronous:
– Text Message payload 202 Accepted response
– Result/output may be retrieved asynchronously once the job is complete
• Maximum payload size is 750KB
• Maximum synchronous wait time is 30 seconds
• Content-Types allowed: application/json, application/xml, text/plain
Create an Alias
To create an alias
1. Go to Profile Administration,Listeners.
2. Click Add Listener.
3. Create an Alias Name you want to distribute to clients:
For example: my-custom-job-url
Caution! You cannot change this later!
4. Select the JobConfig you want this Alias to map to:
For example: My Custom JobConfig (79356)
You can change this later!
Secure an Alias with API Keys
To secure an alias with API keys
1. Go to Profile Administration, Listeners.
2. Click on your Alias record.
3. Click Edit Keys.
4. You can now create or edit the Access Key and Secret Key.
You may view the values any time by clicking the view icon.
Invoking an Alias
WARNING! Using HTTPS is always recommended. Otherwise, API tokens, credentials, and payloads are subject to hijack. HTTPS is always enabled and enforced for DataCloud and VPC deployments.
You can invoke a JobConfig Alias these ways:
• Authorization: Bearer (access_token)
– Bearer tokens can be retrieved from /api/login. (You must set an API Password for your user to call /api/login).
– Bearer tokens can be retrieved using Actian ID or OAuth authorization_code flow.
• Authorization: Basic (encoded user credentials)
– You must set an API Password for your user.
– Credentials are constructed by first combining the Username and Password with a colon (aladdin:opensesame), and then by encoding the resulting string in base64 (YWxhZGRpbjpvcGVuc2VzYW1l).
– Example: Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
• Authorization: Basic (encoded api keys)
– You must create API keys for this Alias.
– Credentials are constructed by first combining the Access Key and Secret Key with a colon (TESTACCESSKEY:TESTSECRETKEY), and then by encoding the resulting string in base64 (VEVTVEFDQ0VTU0tFWTpURVNUU0VDUkVUS0VZ).
– Example: Authorization: Basic VEVTVEFDQ0VTU0tFWTpURVNUU0VDUkVUS0VZ