Versions Compared

Old Version 2

changes.mady.by.user Andrew.Crispino

Saved on

compared with

New Version 3

changes.mady.by.user Andrew.Crispino

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This topic contains step by step instructions for how to use Aptify SOA with Postman.

...

  1. Open Postman.
  2. Click 'Import' button located on top bar.

  3. Navigate to the location of the collection file by drag and drop method or browse the files.

    Info
    titleExpected Result

    The success message will be displayed.


  4. Click 'Manage Environments'.

  5. Add a new environment with any name and the following key and value as given in below table:

    Key

    Value

    BaseServiceURLhttps://[name of the server you are installing the SSO on]/AptifyServicesAPI/services

  6. Click Submit

    Info
    titleExpected Result

    The new environment will be created.


  7. Now, select that environment so that BaseServiceURL in the call URL will be replaced by the environment created.
  8. 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.

...

For manual installation follow the steps given below:

Prompted View

Under the Persons service, create a Prompted List View which expects:

...

  1. Create a new database object with the following details:
    1. Name: spSearchCompanyByID 
    2. DB: Aptify
    3. Type: Stored Procedure

    4. SQL:

      CREATE PROCEDURE spSearchCompanyByID (@ID bigint) AS
      SELECT ID,
      Name
      FROM Company
      WHERE ID = @ID


    5. Grant SQL:

      GRANT EXECUTE ON spSearchCompanyByID TO EndUsers


  2. Create a new service data object with the following details:

    1. Name: spSearchCompanyByID 

    2. SQL: spSearchCompanyByID 
    3. Under Parameters create one record
      1. Name: ID
      2. Is Required: Checked

...

  1. Create a new process flow with the following details:
    1. Name: Create Contact Log
    2. Input Properties:
      1. EntityID - Long, not required, default: 1006
      2. RecordID - Long, required
      3. Description - String, required
    3. Result Codes:
      1. SUCCESS
      2. FAILURE
    4. Add a stock 'Create Contact Log' component
      1. Description: Context Object - Description
      2. CategoryID: Static Value - 1
      3. On the Output Map tab:
        1. GEObject: Context Object - ContactGE
    5. Add a stock 'Create ContactLogLink' component
      1. ParentGEObject: Context Object - ContactGE
      2. EntityID: Context Object - EntityID
      3. AltID: Context Object - RecordID
      4. Action Map tab: Change both to 'End Process' and set the Process Flow result accordingly.
    6. Link 'step d' to the 'step e' on Success.
    7. Set the failed result to end process in 'step d'.
    8. Save the process flow.
    9. Navigate to Web Services > Service Process Flows.
  2. Create a new SPF with the following details:
    1. Name: Create Contact Log
    2. Process Flow: The one we just created (Create Contact Log)
    3. Save the new SPF.


Info

Just in case, please restart IIS, before using Postman.