COUNTER support

GetFTR Entitlements API

Integrators of the GetFTR Entitlements API who wish to participate in COUNTER usage metrics  reporting, should ask the GetFTR support team to:

• Disable the GetFTR Entitlement Cache for their requests
• Disable the GetFTR Centralised Entitlement Service for their requests
• Disable the OA/Free Service for their requests
• Enable including CustomerID in their responses

This ensures that they will receive unaltered responses from publisher APIs, which can contain the publisher’s internal customer ID for each entitlement, if they support the use case:

"org": {
    "ipv4": "1.2.3.4",
    "customerID": "1234567890"
}

GetFTR Centralised Entitlements Service

Direct integrators of the GetFTR Centralised Entitlements Service must set the "X-GETFT-FEATURE-PUBLISHER-IDS" header to the value of "true" in their requests to receive internal customer IDs in the API responses. The IDs will be included in the "publisherIds" array of the entitlement response:

{
    "items": [
        {
            "doi": "10.1234/doi",
            "entitled": true,
            "document": "https://document-link.com",
            "accessType": "PAID",
            "identifiers": [
                0
            ],
            "publisherIds": [
                {
                    "source": "publisher.name",
                    "customerId": "1234567890"
                }
            ],
            ...
        }
    ]
}