> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paulsjob.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create API Keys

> ### POST /v1/company/api-integrations

This endpoint is used to create a new API integration for the company.

#### Request Body

- No request body parameters are required for this endpoint.
    

#### Response

The response for this request will be in JSON format with the following schema:

``` json
{
    "type": "object",
    "properties": {
        "message": {
            "type": "string"
        },
        "status": {
            "type": "integer"
        },
        "data": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "integer"
                },
                "value": {
                    "type": "string"
                }
            }
        }
    }
}

 ```

The response will include:

- `message`: A string indicating the status message.
    
- `status`: An integer representing the status of the request.
    
- `data`: An object containing the `id` and `value` of the newly created API integration.
    

#### Example Response

``` json
{
    "message": "",
    "status": 0,
    "data": {
        "id": 0,
        "value": ""
    }
}

 ```



## OpenAPI

````yaml post /v1/company/api-integrations
openapi: 3.0.0
info:
  title: Pauls Job Public Endpoints
  description: >-
    #### **Description:**


    This API provides a comprehensive suite of endpoints for managing user
    authentication, session control, and other key functionalities within the
    application for Pauls Job. The endpoints are designed to ensure secure and
    efficient communication between clients and the server, offering robust
    access control mechanisms through token-based authentication.


    #### **Key Features:**


    - **Authentication:** Allows users to securely log in using their
    credentials and receive a token for accessing protected resources.
        
    - **Session Management:** Provides a logout mechanism to securely end user
    sessions and invalidate tokens.
        
    - **Error Handling:** Clear and descriptive error messages ensure that
    issues such as invalid credentials, expired tokens, or missing parameters
    are easily identifiable.
        

    This API is built with a focus on security and ease of use, making it
    essential for integrating user authentication and session management into
    applications while maintaining a high standard of data protection.
  version: 1.0.0
servers:
  - url: https://api.hyrd.de
security: []
tags:
  - name: Users
    description: >-
      #### **Description:**


      The folder contains the foundational information and essential API
      endpoints for starting with the authentication and session management of
      the application. This includes the critical login and logout
      functionalities, which are necessary for users to authenticate and manage
      their sessions securely.


      #### **APIs Included:**


      1. **Login API**: Allows users to log in by providing their credentials
      and receive an authentication token.
          
      2. **Logout API**: Enables users to log out by invalidating the token and
      ending their session.
          

      These endpoints are designed to facilitate secure access control and
      session handling, making them an essential starting point for any
      interaction with the platform's protected resources.
  - name: General
  - name: Company
  - name: Company > Candidate
  - name: Company > Api Integrations
paths:
  /v1/company/api-integrations:
    post:
      tags:
        - Company > Api Integrations
      summary: Create API Keys
      description: >-
        ### POST /v1/company/api-integrations


        This endpoint is used to create a new API integration for the company.


        #### Request Body


        - No request body parameters are required for this endpoint.
            

        #### Response


        The response for this request will be in JSON format with the following
        schema:


        ``` json

        {
            "type": "object",
            "properties": {
                "message": {
                    "type": "string"
                },
                "status": {
                    "type": "integer"
                },
                "data": {
                    "type": "object",
                    "properties": {
                        "id": {
                            "type": "integer"
                        },
                        "value": {
                            "type": "string"
                        }
                    }
                }
            }
        }

         ```

        The response will include:


        - `message`: A string indicating the status message.
            
        - `status`: An integer representing the status of the request.
            
        - `data`: An object containing the `id` and `value` of the newly created
        API integration.
            

        #### Example Response


        ``` json

        {
            "message": "",
            "status": 0,
            "data": {
                "id": 0,
                "value": ""
            }
        }

         ```
      requestBody:
        content: {}
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                message: Success
                status: 200
                data:
                  id: 6
                  value: 31c9acca-7075-4bdb-bf83-ff4994843abb
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                message: You are not authorized
                status: 401

````