Knak Modules API

openapi: 3.1.0
info:
  description: '## Overview

    An API specification to provide a Custom Sync Location in Knak.


    By implementing a service conforming to this API specification, you will be able to send asset data to your own service and have that service specify a sync location based on that data.


    ## Authentication

    Knak provides two options for authentication:

    - **Basic Authentication**: Knak will use Basic Authentication to authenticate with your API. You will just need to provide a username and password when configuring the integration.

    - **OAuth2**: Knak will use OAuth2 to authenticate with your API. You will need to implement endpoints under a specified authorization path to support this. The default path will be `/oauth/token` but you can provide a separate path when configuring the integration if you so choose. The flow used is the standard [Authorization Code Grant](https://tools.ietf.org/html/rfc6749#section-4.1).



    Knak will use the tokens generated to make requests from your service.


    ## Custom Sync Location

    When a user has a custom sync location configured and they have set up a sync restriction that leverages the custom sync location.

    Knak will call the `/knak-sync-location` (or your own specified path) endpoint with the asset data when an asset is synced. Your service should return a response with the sync location for the asset.


    When your service provides a sync location, Knak will use that location to display only the available sync location to the user.

    '
  version: V1
  title: Custom Sync Location API Reference Asset Custom Fieldsets Modules API
  x-logo:
    url: https://s3.amazonaws.com/assets.knak.io/img/Knak-Logo-Medium.png
servers:
- url: https://yourService.com/your-sync-location-api
tags:
- name: Modules
paths:
  /modules:
    get:
      description: Retrieve all [modules](#tag/module_model) in your organization that have at least one published version. Modules without a published version are not returned.
      summary: List all modules
      tags:
      - Modules
      parameters:
      - name: filter[name]
        in: query
        description: Filter modules by name. Exact match filter.
        required: false
        schema:
          type: string
          example: Hero Banner
      - name: filter[type]
        in: query
        description: Filter modules by type. Exact match filter.
        required: false
        schema:
          type: string
          enum:
          - email
          - landing
          example: email
      - name: filter[brand_id]
        in: query
        description: Filter modules by associated brand. Accepts one or more comma-separated brand IDs and returns modules associated with any of the given brands.
        required: false
        schema:
          type: string
          example: 63eff7760568a
      - name: sort
        in: query
        description: Sort modules by field (created_at, updated_at).
        required: false
        schema:
          type: string
          example: created_at
      - name: page
        in: query
        required: false
        description: Page number
        example: 1
        schema:
          type: integer
      - name: per_page
        in: query
        required: false
        description: Number of items per page
        example: 10
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleList'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: Authenticate before continuing.
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: This user is not authorized to perform this action. Please adjust permissions before continuing.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: Resource not found.
  /modules/{module_id}:
    get:
      description: Retrieve a specific [module](#tag/module_model)'s metadata, given its module ID. Only modules with at least one published version are returned.
      summary: Retrieve specific module
      tags:
      - Modules
      parameters:
      - name: module_id
        in: path
        required: true
        description: ID of module
        example: 63eff78889f21
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleItem'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: Authenticate before continuing.
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: This user is not authorized to perform this action. Please adjust permissions before continuing.
        '404':
          description: Not Found - the module does not exist or has no published version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: Resource not found.
  /modules/{module_id}/content:
    get:
      description: Retrieve the HTML content of a [module](#tag/module_model)'s latest published version. Draft versions are never returned. Returns a 422 error if the module has no published version.
      summary: Retrieve module content
      tags:
      - Modules
      parameters:
      - name: module_id
        in: path
        required: true
        description: ID of module
        example: 63eff78889f21
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModuleContent'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: Authenticate before continuing.
        '403':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: This user is not authorized to perform this action. Please adjust permissions before continuing.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Response'
              example:
                message: Resource not found.
        '422':
          description: Unprocessable Entity - the module has no published version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                errors:
                - status: '422'
                  title: Unprocessable Entity
                  detail: This module has no published version. Publish the module in Knak before requesting its content.
                  meta:
                    module_id: 63eff78889f21
components:
  schemas:
    ModuleList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Module'
        links:
          type: object
          properties:
            first:
              type: string
              example: https://enterprise.knak.io/api/published/v1/modules?page=1
            last:
              type: string
              example: https://enterprise.knak.io/api/published/v1/modules?page=3
            prev:
              type: string
              nullable: true
              example: https://enterprise.knak.io/api/published/v1/modules?page=1
            next:
              type: string
              nullable: true
              example: https://enterprise.knak.io/api/published/v1/modules?page=3
        meta:
          type: object
          properties:
            current_page:
              type: integer
              example: 1
            from:
              type: integer
              example: 1
            last_page:
              type: integer
              example: 3
            links:
              type: array
              items:
                type: object
                properties:
                  url:
                    type: string
                    nullable: true
                    example: https://enterprise.knak.io/api/published/v1/modules?page=2
                  label:
                    type: string
                    example: Next
                  active:
                    type: boolean
                    example: true
            path:
              type: string
              example: https://enterprise.knak.io/api/published/v1/modules?page=2
            per_page:
              type: integer
              example: 10
            to:
              type: integer
              example: 2
            total:
              type: integer
              example: 2
    Module:
      type: object
      properties:
        type:
          type: string
          example: module
        id:
          type: string
          example: 63eff78889f21
        attributes:
          type: object
          properties:
            id:
              type: string
              example: 63eff78889f21
            name:
              type: string
              example: Hero Banner
            type:
              type: string
              enum:
              - email
              - landing
              example: email
            status:
              type: string
              enum:
              - draft
              - final
              example: final
            category:
              type: object
              nullable: true
              properties:
                id:
                  type: string
                  example: 63eff7760568b
                name:
                  type: string
                  example: Headers
            brand_ids:
              type: array
              items:
                type: string
              example:
              - 63eff7760568a
            created_at:
              type: string
              format: date-time
              example: '2023-05-17T21:54:19Z'
            updated_at:
              type: string
              format: date-time
              example: '2023-05-18T19:55:21Z'
    ModuleContent:
      type: object
      properties:
        data:
          type: object
          properties:
            type:
              type: string
              example: module-content
            id:
              type: string
              example: 63eff78889f21
            attributes:
              type: object
              properties:
                id:
                  type: string
                  example: 63eff78889f21
                name:
                  type: string
                  example: Hero Banner
                type:
                  type: string
                  enum:
                  - email
                  - landing
                  example: email
                status:
                  type: string
                  enum:
                  - draft
                  - final
                  example: final
                category:
                  type: object
                  nullable: true
                  properties:
                    id:
                      type: string
                      example: 63eff7760568b
                    name:
                      type: string
                      example: Headers
                brand_ids:
                  type: array
                  items:
                    type: string
                  example:
                  - 63eff7760568a
                version:
                  type: string
                  example: '2'
                html:
                  type: string
                  example: <div>Hero banner content</div>
    ModuleItem:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Module'
    Response:
      type: object
      properties:
        message:
          type: string
          example: This is the response message to the request made.
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
                description: HTTP status code as a string. Returned by endpoints that use the JSON:API error shape.
                example: '409'
              title:
                type: string
              detail:
                type: string
              meta:
                type: object
                description: Additional context for the error. Returned by endpoints that use the JSON:API error shape.
                additionalProperties: true