Custom Schema - Data Provider API Reference

OpenAPI

To configure your custom Open Data environment you share an OpenAPI Schema with Fiskil that defines your resource server API. This schema contains:

Your endpoints
Permissions required to access each endpoint

Endpoint Requirements

The paths in your endpoints must contain /customer/{customerId} so Fiskil can request the data for the user who authorised sharing. For example:

paths:
  /v1/customer/{customerId}/pay:
    get:
      description: Shows the users pay information e.g. salary, pay frequency, Year To Date (YTD) earnings.
      operationId: getPayInformation
      parameters:
        - description: ID of a customer.
          explode: false
          in: path
          name: customerId
          required: true
          schema:
            type: string
          style: simple

The customer/{customerId} path parameter is required to ensure data from the correct customer is accessed.

Third parties requesting data from your environment don't provide the customer/{customerId} in their request, Fiskil trims this from the API endpoint. For example: you might provide an OpenAPI definition with the following endpoints:

/v1/customer/{customerId}/pay
/v1/customer/{customerId}/payslips
/v1/customer/{customerId}/payslips/{id}

Your Fiskil Open Data API will expose the following endpoints:

/v1/pay
/v1/payslips
/v1/payslips/{id}

The customer ID in the request to your server is set based on the user associated with the access token used to request the data.

Scopes

Open ID Connect Scopes are used to authorise the sharing of specific datasets from your users. Your users review the scopes being requested by third parties so they know exactly what data they are sharing. Fiskil uses two OpenAPI extensions to define the scopes required to access your data.

Data Sharing endpoints must have a x-fiskil-scopes extension defining the scopes that must be authorised by the user to access the data
The info block must contain a x-fiskil-scopeset extension that defines the list of scopes supported and descriptions of them

For example:

info:
  title: Mock Payroll API
  x-fiskil-scopeset:
    "payroll:pay:read":
      cluster_language: "Payroll - Read pay information"
      permission_language:
        - "Annual Salary"
        - "Pay Frequency"
        - "YTD Earnings"
paths:
  /v1/customer/{customerId}/pay:
    get:
      description: Shows the users pay information e.g. salary, pay frequency, Year To Date (YTD) earnings.
      summary: Get Pay Information
      operationId: getPayInformation
      parameters:
        - description: ID of a customer.
          explode: false
          in: path
          name: customerId
          required: true
          schema:
            type: string
          style: simple
      x-fiskil-scopes:
        - 'payroll:pay:read'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsePayInformation'
          description: Success
      summary: Get Pay Information

In this example the x-fiskil-scopeset extension on the info element lists the available scopes: payroll:pay:read. The cluster_language field presents a high-level description of the data that is shared. The permissions_language field shows the exact pieces of data that fall under this scope.

The x-fiskil-scopes extension on the getPayInformation operation shows that the payroll:pay:read scope is required if a third party wants to access the pay dataset.

This information is shown to the end user during authorisation

Uploading your OpenAPI Specification

You provide your OpenAPI Specification to Fiskil through the Fiskil Data Provider console. Navigate to the Resource Server Settings Menu and upload your specification.

The Fiskil platform will validate your OpenAPI document against the requirements listed above. Once you've uploaded your specification, develop your resource server to implement your OpenAPI specification.

After completing both these steps your environment is ready for testing.

Download a full example of a Fiskil-compatible OpenAPI definition including customer ID path parameters and scope definitions

Extension Reference

`x-fiskil-scopeset`

Parent element: info Type: Map<string, object> Object properties:

cluster_language: string
permission_language: List<string>

Example:

info:
  x-fiskil-scopeset:
    payroll:pay:read:
      cluster_language: Payroll - Read pay information
      permission_language:
        - Annual Salary
        - Pay Frequency
        - YTD Earnings

`x-fiskil-scopes`

Parent element: method Type: List<string>

All values within the list must be present as a key in the x-fiskil-scopeset map.

Example:

paths:
  /v1/customer/{customerId}/pay:
    get:
      description: Shows the users pay information e.g. salary, pay frequency, Year To Date (YTD) earnings.
      x-fiskil-scopes:
        - payroll:pay:read
      # Remaining method content excluded...