Awsmarketplace API

• awsMarketplace
  • getAWS Marketplaceの設定を取得
  • putAWS Marketplaceの設定を更新
  • getAWS Marketplaceの出品状況を取得
  • putAWS Marketplaceの出品状況を更新
  • getAWS Marketplaceに連携するプラン情報を取得
  • putAWS Marketplaceに連携するプラン情報を登録
  • getAWSMarketplaceに連携するプラン情報を取得
  • postAWS Marketplaceに連携する顧客情報を新規作成
  • getAWS Marketplaceに連携する顧客情報の一覧を取得
  • getAWS Marketplaceに連携する顧客情報を取得
  • postAWS Marketplaceの顧客情報をSaaSusに同期
  • getAWS CloudFormationのスタック作成リンクを取得
  • postRegistration Tokenを検証
  • getAWS Marketplaceから商品の公開状況を取得
• error
  • getステータスコード500でサーバーエラーを返却

API docs by Redocly

SaaSus AWS Marketplace API Schema (1.0.0)

SaaSus AWS Marketplace API Schema

awsMarketplace

AWS Marketplaceリソースの操作

AWS Marketplaceの設定を取得

AWS Marketplaceの設定を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/settings

Response samples

• 200
• 500

Content type

application/json

{

• "product_code": 1234567890,
• "role_arn": "arn:aws:iam::123456789012:role/role-name",
• "role_external_id": 1234567890,
• "sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:topic-name",
• "cas_bucket_name": "cas-bucket-name",
• "cas_sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:topic-name",
• "seller_sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:topic-name",
• "redirect_sign_up_page_function_url": "http://example.com/sign-up",
• "sqs_arn": "arn:aws:sqs:us-east-1:123456789012:queue_name"

}

AWS Marketplaceの設定を更新

AWS Marketplaceの設定を更新します。

Authorizations:

Bearer

Request Body schema: application/json

product_code	string
role_arn	string
role_external_id	string
sns_topic_arn	string
cas_bucket_name	string
cas_sns_topic_arn	string
seller_sns_topic_arn	string
sqs_arn	string

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/settings

Request samples

• Payload

Content type

application/json

{

• "product_code": 1234567890,
• "role_arn": "arn:aws:iam::123456789012:role/role-name",
• "role_external_id": 1234567890,
• "sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:topic-name",
• "cas_bucket_name": "cas-bucket-name",
• "cas_sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:topic-name",
• "seller_sns_topic_arn": "arn:aws:sns:us-east-1:123456789012:topic-name",
• "sqs_arn": "arn:aws:sqs:us-east-1:123456789012:queue_name"

}

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

AWS Marketplaceの出品状況を取得

AWS Marketplaceの出品状況を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/listing-status

Response samples

• 200
• 500

Content type

application/json

{

• "listing_status": "no_listing"

}

AWS Marketplaceの出品状況を更新

AWS Marketplaceの出品状況を更新します。

Authorizations:

Bearer

Request Body schema: application/json

listing_status required

string (AWS Marketplace出品状況) Enum: "no_listing" "first_step_working" "first_step_completed" "second_step_working" "second_step_plan_created" "second_step_completed" "third_step_working" "third_step_completed" "limited" "restricted" "public"

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/listing-status

Request samples

• Payload

Content type

application/json

{

• "listing_status": "no_listing"

}

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

AWS Marketplaceに連携するプラン情報を取得

Marketplaceと連携するプラン情報を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/plans

Response samples

• 200
• 500

Content type

application/json

{

• "plans": [

  • {

    • "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
    • "plan_name": "normal_plan_name_month"

    }

  ]

}

AWS Marketplaceに連携するプラン情報を登録

AWSMarketplaceに連携するプラン情報を登録します。

Authorizations:

Bearer

Request Body schema: application/json

plan_id required	string (Uuid)
plan_name required	string

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/plans

Request samples

• Payload

Content type

application/json

{

• "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "plan_name": "normal_plan_name_month"

}

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

AWSMarketplaceに連携するプラン情報を取得

Marketplaceと連携するプラン情報を取得します。

Authorizations:

Bearer

path Parameters

plan_name required

string Example: normal_plan_name_month AWS Marketplace連携プラン名

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/plans/{plan_name}

Response samples

• 200
• 500

Content type

application/json

{

• "plan_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "plan_name": "normal_plan_name_month"

}

AWS Marketplaceに連携する顧客情報を新規作成

AWS Marketplaceに連携する顧客情報を新規作成します。

Authorizations:

Bearer

Request Body schema: application/json

tenant_id required	string (Uuid)
registration_token required	string

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/customers

Request samples

• Payload

Content type

application/json

{

• "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775",
• "registration_token": "registration_token"

}

Response samples

• 201
• 500

Content type

application/json

{

• "customer_identifier": "123456789012",
• "customer_aws_account_id": "123456789012",
• "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

}

AWS Marketplaceに連携する顧客情報の一覧を取得

Get a list of customer information to be linked to AWS Marketplace.

Authorizations:

Bearer

query Parameters

tenant_ids

Array of strings (Uuid) Example: tenant_ids=69e732d6-8ecc-45c4-c2eb-8438f7ffe775 指定したテナントIDの顧客を取得する(Get customers with the specified tenant ID)

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/customers

Response samples

• 200
• 500

Content type

application/json

{

• "customers": [

  • {

    • "customer_identifier": "123456789012",
    • "customer_aws_account_id": "123456789012",
    • "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

    }

  ]

}

AWS Marketplaceに連携する顧客情報を取得

AWS Marketplaceに連携する顧客情報を取得します。

Authorizations:

Bearer

path Parameters

customer_identifier required

string Example: 123456789012 顧客ID

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/customers/{customer_identifier}

Response samples

• 200
• 500

Content type

application/json

{

• "customer_identifier": "123456789012",
• "customer_aws_account_id": "123456789012",
• "tenant_id": "69e732d6-8ecc-45c4-c2eb-8438f7ffe775"

}

AWS Marketplaceの顧客情報をSaaSusに同期

AWS Marketplaceの顧客情報をSaaSusに同期します。

Authorizations:

Bearer

path Parameters

customer_identifier required

string Example: 123456789012 顧客ID

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/customers/{customer_identifier}/sync

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

AWS CloudFormationのスタック作成リンクを取得

CloudFormationのクイック作成リンクを取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/cloudformation-launch-stack-link

Response samples

• 200
• 500

Content type

application/json

{

• "link": "https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks/create?stackName=sample&templateURL=https://s3.us-west-2.amazonaws.com/cloudformation-templates-sample.template"

}

Registration Tokenを検証

Registration Tokenを検証します。

Authorizations:

Bearer

Request Body schema: application/json

registration_token required

string

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/registration-token/verify

Request samples

• Payload

Content type

application/json

{

• "registration_token": "registration_token"

}

Response samples

• 400
• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}

AWS Marketplaceから商品の公開状況を取得

AWS Marketplaceから商品の公開状況を取得します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/catalog-entity/visibility

Response samples

• 200
• 500

Content type

application/json

{

• "visibility": "Public"

}

error

テスト用途のエラー

ステータスコード500でサーバーエラーを返却

テスト用途で使用するエンドポイントです。ステータスコード500でサーバーエラーを返却します。

Authorizations:

Bearer

Responses

Production API Server

https://api.saasus.io/v1/awsmarketplace/errors/internal-server-error

Response samples

• 500

Content type

application/json

{

• "type": "permission_denied",
• "message": "エラーメッセージ"

}