xzxzyzyz/laravel-conoha-api

Using Conoha Api in Laravel

0.1.0 2018-01-23 08:29 UTC

Requires

• php: >=7.0
• laravel/framework: 5.5.*

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: ^6.4

MIT

• Xzxzyzyz

• laravel
• ConoHa

README

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

Laravel 5.5+

Installation

composer require xzxzyzyz/laravel-conoha-api

※keika299/chapが必要だが現在非公開なので、ソースコードをダウンロードしてcomposer.jsonへ追加して読み込む

...
    "psr-4": {
        "App\\": "app/",
        "keika299\\ConohaAPI\\": "chap/src/"
    }
...

config/app.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

return [
    'service_id' => 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を参照

Events

#	EVENT
ドメイン作成時	\Xzxzyzyz\ConohaAPI\Events\DomainCreatedEvent
ドメイン削除時	\Xzxzyzyz\ConohaAPI\Events\DomainDeletedEvent
メールアドレス作成時	\Xzxzyzyz\ConohaAPI\Events\EmailCreatedEvent
メールアドレス削除時	\Xzxzyzyz\ConohaAPI\Events\EmailDeletedEvent