epilot-app-schufa/openapi.yml at main · epilot-dev/epilot-app-schufa · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
openapi: 3.1.0
info:
  title: epilot Schufa App
  version: 1.0.0
  contact:
    name: epilot GmbH
    url: https://epilot.cloud
  description: Simple API to check a schufa report
servers:
  - url: https://schufa-app.sls.epilot.io
tags:
  - name: schufa
paths:
  /api/v1/schufa/check:
    post:
      operationId: schufaCheck
      summary: schufaCheck
      description: Check a schufa report
      tags:
        - schufa
      requestBody:
         $ref: "#/components/requestBodies/SchufaCheckRequest"
      responses:
        "200":
          description: Received successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SchufaReport"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "403":
          description: Forbidden
        "404":
          description: Not Found
        "500":
          description: Internal server error

security:
  - accessToken: []

components:
  requestBodies:
    SchufaCheckRequest:
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              timestamp:
                type: string
                description: The timestamp of the action
                example: "2023-10-01T12:00:00Z"
              data:
                type: object
                description: The data to be forwarded to the zapier trigger
                properties:
                  org_id:
                    type: string
                    description: The id of the epilot organization
                    example: "123"
                  app_options:
                    type: object
                    additionalProperties: true
                    required:
                      - client_id
                    properties:
                      enable_test_mode:
                        type: boolean
                        description: Whether the schufa app is in test mode. The test mode uses a random score and description.
                        default: false
                      client_id:
                        type: string
                        description: The client id of the schufa app
                        example: "client_123"
                  entity:
                    type:: object
                    additionalProperties: true
                required:
                  - entity
                  - app_options
                  - org_id
            required:
              - data
  schemas:
    SchufaReport:
      type: object
      additionalProperties: true
      properties:
        skip_reason:
          type: string
          description: If this is present the action was skipped and the reason is given
          example: "User consent not given"
        error_output:
          type: object
          description: If this is present the action failed and the error message is given
          properties:
            error_reason:
              type: string
              description: The reason for the error
              example: "Invalid client id"

  securitySchemes:
    accessToken:
      type: http
      scheme: bearer
      description: Authorization header with epilot access token
      bearerFormat: JWT