https://github.com/xzxzyzyz/laravel-conoha-api

Using Conoha API in Laravel
https://github.com/xzxzyzyz/laravel-conoha-api

conoha laravel

Last synced: 19 days ago
JSON representation

Using Conoha API in Laravel

• Host: GitHub
• URL: https://github.com/xzxzyzyz/laravel-conoha-api
• Owner: xzxzyzyz
• License: mit
• Created: 2018-01-23T07:19:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-03-28T11:05:40.000Z (almost 7 years ago)
• Last Synced: 2024-11-21T15:19:55.880Z (about 1 month ago)
• Topics: conoha, laravel
• Language: PHP
• Size: 15.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Conoha API

ConohaのAPIをLaravelで利用する (メール)

Laravel 5.5+

## Installation

```bash

composer require xzxzyzyz/laravel-conoha-api

```

※[keika299/chap](https://github.com/ezaki/chap)が必要だが現在非公開なので、ソースコードをダウンロードして`composer.json`へ追加して読み込む

```json

...

    "psr-4": {

        "App\\": "app/",

        "keika299\\ConohaAPI\\": "chap/src/"

    }

...

```

`config/app.php`へ追加

```php

    'providers' => [

        ...

        Xzxzyzyz\ConohaAPI\Providers\ConohaServiceProvider::class,

        Xzxzyzyz\ConohaAPI\Providers\RouteServiceProvider::class,

    ],

    

    ...

    

    'aliases' => [

    

        ...

        'Conoha' => Xzxzyzyz\ConohaAPI\Facade\Conoha::class,

    ],

```

`.env`へ追加

```

CONOHA_SERVICE_ID=your_service_id # サーバー ->サーバー情報 -> UUID

CONOHA_TENANT_ID=your_tenant_id # API -> テナント情報 -> テナントID

CONOHA_API_USERNAME=your_api_username # API -> APIユーザー -> ユーザー名

CONOHA_API_PASSWORD=your_api_password # API -> APIユーザー -> パスワード

```

`config/conoha.php`

```php

 env('CONOHA_SERVICE_ID'),

    'tenant_id' => env('CONOHA_TENANT_ID'),

    'username' => env('CONOHA_API_USERNAME'),

    'password' => env('CONOHA_API_PASSWORD'),

    'domain' => [

        'ignore_origin' => true

    ],

    'email' => [

        'auto_password' => true

    ]

];

```

## Usage

### ドメイン

|#|URL|METHOD|PARAMS|

|:---|:---|:---|:---|

|一覧|GET|api/domain| |

|作成|POST|api/domain|domain_name:ドメイン名|

|参照|GET|api/domain/{domain_name}| |

|削除|DELETE|api/domain/{domain_name}| |

### メールアドレス

`domian_id`はドメイン作成時にConoha上で作成されるドメインID (UUID)

|#|URL|METHOD|PARAMS|

|:---|:---|:---|:---|

|一覧|GET|api/domain/{domain_id}/email| |

|作成|POST|api/domain/{domain_id}/email|email:メールアドレス, password:パスワード|

|参照|GET|api/domain/{domain_id}/email/{email}| |

|削除|DELETE|api/domain/{domain_id}/email/{email}| |

### メッセージ

`email_id`はドメイン作成時にConoha上で作成されるメールID (UUID)

|#|URL|METHOD|PARAMS|

|:---|:---|:---|:---|

|一覧|GET|api/domain/{domain_id}/email/{email_id}/message| |

|参照|GET|api/domain/{domain_id}/email/{email_id}/message/{message_id}| |

※ routeについては`RouteServiceProvider`で読み込んでいる[api.php](https://github.com/xzxzyzyz/laravel-conoha-api/blob/master/src/Http/api.php)を参照

## Events

|#|EVENT|

|:---|:---|

|ドメイン作成時|\Xzxzyzyz\ConohaAPI\Events\DomainCreatedEvent|

|ドメイン削除時|\Xzxzyzyz\ConohaAPI\Events\DomainDeletedEvent|

|メールアドレス作成時|\Xzxzyzyz\ConohaAPI\Events\EmailCreatedEvent|

|メールアドレス削除時|\Xzxzyzyz\ConohaAPI\Events\EmailDeletedEvent|