plc-xi/core

Core Module for PLC XI Api Server

Maintainers

Details

github.com/OnePlc/plc-xi-api-core

Homepage

Source

Issues

Documentation

Installs: 4

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

Type:project

dev-main 2022-11-27 02:26 UTC

Requires

Requires (Dev)

Suggests

Conflicts

BSD-3-Clause 28c0aafa0633ee0b4be8741ba2997e13e098de9d

frameworkapilaminasapi-toolsplc-xi

This package is auto-updated.

Last update: 2024-12-27 06:35:30 UTC

README

Core Module for onePlace XI Api Server.

How to start locally

  • Enter Projekt directory, run composer install
  • Create config/autoload/local.php
  • Start Dev Server php -S 0.0.0.0:8080 -t public public/index.php
  • The API is now running on localhost:8080
return [
    'db' => [
        'adapters' => [
            'api' => [
                'database' => 'nameOfYourDatabase',
                'driver' => 'PDO_Mysql',
                'username' => 'databaseUser',
                'password' => 'databasePassword',
            ],
        ],
    ],
    'api-tools-mvc-auth' => [
        'authentication' => [
            'adapters' => [
                'api' => [
                    'adapter' => \Laminas\ApiTools\MvcAuth\Authentication\OAuth2Adapter::class,
                    'storage' => [
                        'adapter' => \pdo::class,
                        'dsn' => 'mysql:dbname=nameOfYourDatabase;host=localhost;charset=utf8',
                        'route' => '/oauth',
                        'username' => 'databaseUser',
                        'password' => 'databasePassword',
                    ],
                ],
            ],
        ],
    ],
];

Configure Authentication

  • Insert a new row into oauth_clients table
    • client_id is the username for your client
    • client_secret is the hashed password for your client
      • You can use php .\vendor\laminas-api-tools\api-tools-oauth2\bin\bcrypt.php yourPassword to generate a bcrypt hash