VTEX DKIM Configuration API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account DKIM Configuration API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: DKIM Configuration
paths:
  /api/mail-service/pvt/providers/{EmailProvider}/dkim:
    post:
      summary: VTex Generate DKIM keys
      description: Create DKIM keys for sender that was setup in VTEX mail servers
      operationId: createDKIM
      tags:
      - DKIM Configuration
      parameters:
      - name: EmailProvider
        in: path
        required: true
        description: E-mail address for sender that was setup in VTEX mail servers
        schema:
          type: string
          default: help@valdie.co
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200_OK'
              examples:
                emailNotFound:
                  summary: emailNotFound summary
                  value:
                    status: emailNotFound
                    dkimKeys: null
                emailNotVerified:
                  summary: emailNotVerified summary
                  value:
                    status: emailNotVerified
                    dkimKeys: null
                created:
                  summary: created summary
                  value:
                    status: created
                    dkimKeys:
                    - '''n3zbltwizctxpgcmqrars4bmfdd3zlyo._domainkey.valdie.co'',''CNAME'',''n3zbltwizctxpgcmqrars4bmfdd3zlyo.dkim.amazonses.com'''
                    - '''sq4iae4be52fhqq3wm44btttvndeecfv._domainkey.valdie.co'',''CNAME'',''sq4iae4be52fhqq3wm44btttvndeecfv.dkim.amazonses.com'''
                    - '''n4z6g2g7yfy4pnhjklfesxrrkt4o2ha4._domainkey.valdie.co'',''CNAME'',''n4z6g2g7yfy4pnhjklfesxrrkt4o2ha4.dkim.amazonses.com'''
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401_Unauthorized'
              examples:
                unauthorized:
                  summary: unauthorized summary
                  value:
                    type: https://tools.ietf.org/html/rfc7235#section-3.1
                    title: Unauthorized
                    status: 401
                    traceId: 00-f8949e0e2a80ff4481b4375908349701-a6a7ecf8b50a2043-00
components:
  schemas:
    200_OK:
      type: object
      additionalProperties: true
      required:
      - status
      properties:
        status:
          type: string
          enum:
          - emailNotFound
          - emailNotVerified
          - created
        dkimKeys:
          type: array
          additionalProperties: true
          nullable: true
    401_Unauthorized:
      type: object
      additionalProperties: true
      required:
      - type
      - title
      - status
      - traceId
      properties:
        type:
          type: string
          enum:
          - https://tools.ietf.org/html/rfc7235#section-3.1
        title:
          type: string
          enum:
          - Unauthorized
        status:
          type: integer
          enum:
          - 401
        traceId:
          type: string
          pattern: ^00-[0-9a-f]{32}-[0-9a-f]{16}-00$
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'