This topic contains step by step instructions for how to use Aptify SOA with Postman.
...
- Open Postman.
- Click 'Import' button located on top bar.
Navigate to the location of the collection file by drag and drop method or browse the files.
Info title Expected Result The success message will be displayed.
- Click '
Manage Environments
'. Add a new environment with any name and the following key and value as given in below table:
Key
Value
BaseServiceURL https://[name of the server you are installing the SSO on]/AptifyServicesAPI/services Click Submit
Info title Expected Result The new environment will be created.
- Now, select that environment so that BaseServiceURL in the call URL will be replaced by the environment created.
- In 'Preferences', go to Settings → Language Detection →
JSON
.
Note |
---|
Postman is nice enough to send the token for us in any request made after logging. When you start making calls through code (JavaScript, .NET or anything else) then we need to manually add the token in the header. |
Info |
---|
When token is not passed automatically Sometimes Postman does not pass the token automatically. In these cases you will need to manually add the token to all requests as given below: Header Name: AptifyAuthorization Header Value: Authentication Provider (SQL, Domain, etc.) and the token separated by a single space. |
Configuring Web Users
...
- Create a new process flow with the following details:
- Name: Create Contact Log
- Input Properties:
- EntityID - Long, not required, default: 1006
- RecordID - Long, required
- Description - String, required
- Result Codes:
- SUCCESS
- FAILURE
- Add a stock 'Create Contact Log' component
- Description: Context Object - Description
- CategoryID: Static Value - 1
- On the Output Map tab:
- GEObject: Context Object - ContactGE
- Add a stock 'Create ContactLogLink' component
- ParentGEObject: Context Object - ContactGE
- EntityID: Context Object - EntityID
- AltID: Context Object - RecordID
- Action Map tab: Change both to 'End Process' and set the Process Flow result accordingly.
- Link 'step d' to the 'step e' on Success.
- Set the failed result to end process in 'step d'.
- Save the process flow.
- Navigate to Web Services > Service Process Flows.
- Create a new SPF with the following details:
- Name: Create Contact Log
- Process Flow: The one we just created (Create Contact Log)
- Save the new SPF.
Info |
---|
Just in case, please restart IIS, before using Postman. |