Home > Tech Writers Hub > Knowledge Services Sandbox > Aria Media Publishing Suite > Interface and Integration Definitions for Access Management

Interface and Integration Definitions for Access Management

Overview

This document describes the API methods used for Access Management when integrating with the Aria Media and Publishing Suite (AMPS). The Access Management component is a set of generic components that are designed for use within both standard AMPS implementations and customer-specific workflows. This document describes the Access Management functionality to manage the distribution of access rights for customers subscribing to digital media. Whenever a subscriber changes their set of subscriptions (additions, cancellations, etc.) the details are transferred to the access control system in use. This system then provides the necessary access to newspapers, articles, etc. Integration with some access control systems are provided from the start, but new integrations can be added as required.

The APIs described in this document form the foundation for the request/reply structures for Access Management supported by AMPS. CLIENTS of Aria can extend the suite but not alter its internal functioning, primarily through client-managed development in integrated systems.

For AMPS to function as described, several account and product fields must be added to objects such as accounts, plans, plan instances, services and usage types within Aria Core. See Aria Media and Publishing Suite - Aria Core Configuration for details regarding these fields.

Access Management

The following details the definition of the APIs provided by the Access Management part of AMPS. The following messages are provided:

Each of the above APIs are described below.

Event Request (JSON API)

SolmEventRequest

The solmEventRequest message is a JSON formatted message used to transfer details on the event generated by Aria Core and which need to be processed. Refer to the Aria Foundation Suite for more information on this message structure.

SolmEventResponse

The solmEventResponse message is a JSON formatted message used to report the outcome of the event processing. Refer to the Aria Foundation Suite for more information on this message structure.

Access Control

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/AccAccessControl

AccAccessListRequest

The accAccessListRequest structure is used to transfer details on the access control to be transferred to the external access control system. The information in this structure will be used to format the access control system specific message. 

Sample 1
A sample request providing access to two titles each with different access features. 
{
    "accAccessListAcctInfo": {
        "ariaAccountID": "ACCT-1",
        "ariaAccountNo": 12345,
        "ariaUserID": "USER-1",
        "ariaAddAccountID": "ADDACCT-1", 
        "numberOfAllotments": 1
    },
    "accAccessListTitleList": [
        {
            "accAccessListTitleInfo": {
                "titleCode": "RB",
                "accessTitleCode": "ARB",
                "titleDomain": "www.rb.no",
                "eligibleForSharing": true
            },
            "accAccessListTitleAccessInfo": [
                {"accessFeature": "SPORT"},
                {"accessFeature": "FINANCE"}
            ]
        },
        {
            "accAccessListTitleInfo": {
                "titleCode": "RB",
                "accessTitleCode": "ARB",
                "titleDomain": "www.rb.no",
                "eligibleForSharing": true
            },
            "accAccessListTitleAccessInfo": [
                {"accessFeature": "NEWSPAPER"}
            ]
        }
    ]
}


The accAccessListAcctInfo is a structure holding the general details on the subscriber (i.e., account holder). It contains the following fields:

  • accAccessListAcctInfo – the overall name of the structure.
    • ariaAccountID – contains the client-defined identification of the subscriber (customer).
    • ariaAccountNo – contains the Aria generated identification of the subscriber (customer).
    • ariaUserID – contains the client defined userid assigned to the subscriber.
    • ariaAddAccountID – contains an additional client-defined identification of the subscriber (customer).
    • numberOfAllotments – contains the number of allotments that this customer has been assigned. The number is used to control how many users that access can be shared between. One (1) is the default value and means that only the owner has access. A value of 10 means that up to 10 users may have access. 

The accAccessListTitleList is an array structure holding an entry for each title to which access is granted. Each entry contains the following fields:

  • accAccessListTitleInfo– a common structure general information on the title to which access is granted.
    • titleCode – contains the identification of the title code to which the subscriber has access.
    • accessTitleCode – contains a client-defined identification of the title code as known by the external access control system.
    • titleDomain – contains the client-defined domain name under which the title operates.  
    • eligibleForSharing – contains an indication of whether the title and associated access can be shared between users. False indicate that is cannot, while true indicates that it can. 
  • accAccessListTitleAccessInfo – an array structure holding details on the access features used for a given title. 
    • accessFeature – contains the code used to define what access a subscriber is given for the current title. 

AccAccessListResponse

The accAccessListResponse structure used to report the outcome of the transfer of access control information to the external access control system. 

Sample 1
A general sample response 
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
}

The individual data elements of resultInfo are defined as follows:

  • resultCode – contains the result of the request processing. A value of 0 (zero) indicates success. Other codes indicate failure. 
  • resultText – contains a short text describing the error encountered. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 
     

Retrieve Access List (JSON API)

Endpoint

This API can be called by making a POST call to the URL: https://[clienthost]/PostDataToFlow/ARIAPublishingSuite/DistributionManagement/AccRetrieveAccessList

AccRetrieveAccessListRequest

The accRetrieveAccessListRequest structure is used to request the current position on a customer's access to titles and the features it provides. The following samples have been provided:

•    Sample 1); A request for access list information for a given account id:

Sample 1
A sample request providing access to two titles each with different access features. 
{
    "msgAuthDetails": {
        "clientNo": 90000259,
        "authKey": " acXKhw4s47RRXs535VYYWbvfQ8uXXXXXX ",
        "requestDateTime": "2018-03-30T14:30:20",
        "signatureValue": "15f52c75de7a09fece579cf06f41350bd7a99f05a275fa60fb2958b6bc045453",
        "signatureVersion": "1.0",
        "ariaAccountID": "",
        "ariaAccountNo": 0,
        "userID": "ABC-USER"
    },
    "accRetrieveAccessListCriteria": {
        "ariaAccountID": "ACCT-1",
        "ariaAccountNo": null
    }
}


The accRetrieveAccessListCriteria is a structure holding the criteria used to retrieve the access control information. It contains the following fields:

  • accRetrieveAccessListCriteria – the overall name of the structure.
    • ariaAccountID – contains the client-defined identification of the subscriber (customer). If both ariaAccountID and ariaAccountNo is provided, then ariaAccountID will take precedence. 
    • ariaAccountNo – contains the Aria generated identification of the subscriber (customer).

AccRetrieveAccessListResponse

The accRetrieveAccessListResponse structure is used to return details on the access control information to the external access control system. The following samples have been provided:

•    Sample 1); A response showing details for a given account with access to two titles and related features.

Sample 1
A sample request providing access to two titles each with different access features. 
{
{
    "resultInfo": {
        "resultCode": 0,
        "resultText": "OK"
    },
    "accRetrieveAccessListInfo": {
        "ariaAccountID": "ACCT-1",
        "ariaAccountNo": null,
        "numberOfAllotments": 1,
        "accRetrieveAccessListFeatureList": [
            {
                "titleDomain": "www.rb.no",
                "accessFeature": "NEWSPAPER", 
                "eligibleForSharing": true
            },
            {
                "titleDomain": "www.dt.no",
                "accessFeature": "NEWSPAPER", 
                "eligibleForSharing": true
            }
        ]
    }
}


The individual data elements of resultInfo are defined as follows:

  • resultCode – contains the result of the request processing. A value of 0 (zero) indicates success. Other codes indicate failure. 
  • resultText – contains a short text describing the error encountered. Is returned as “OK” when success is returned. For other error codes the text describes the error encountered. 

The accAccessListAcctInfo is a structure holding the general details on the subscriber (i.e., account holder). It contains the following fields:

  • accRetrieveAccessListInfo – the overall name of the structure.
    • ariaAccountID – contains the client-defined identification of the subscriber (customer).
    • ariaAccountNo – contains the Aria generated identification of the subscriber (customer).
    • numberOfAllotments – contains the number of allotments that this customer has been assigned. The number is used to control how many users that access can be shared between. One (1) is the default value and means that only the owner has access. A value of 10 means that up to 10 users may have access. 
    • accRetrieveAccessListFeatureList – contains one or more entries indicating the type of access given to the subscriber. Is defined in detail later in this section. 

The accRetrieveAccessListFeatureList is an array structure holding an entry for each title to which access is granted. Each entry contains the following fields:

  • accRetrieveAccessListFeatureList – a common structure general information on the title to which access is granted.
    • titleDomain – contains the client-defined domain name under which the title operates.  
    • accessFeature – contains the code used to define what access a subscriber is given for the current title. 
    • eligibleForSharing – contains an indication of whether the title and associated access can be shared between users. False indicate that is cannot, while true indicates that it can. 
       

 


Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.