Awsmarketplace API

• awsMarketplace
  • getGet AWS Marketplace Settings
  • putUpdate AWS Marketplace Settings
  • getGet AWS Marketplace Listing Status
  • putUpdate AWS Marketplace Listing Status
  • getObtain plan information to link to AWS Marketplace
  • putSave plan information to be linked to AWSMarketplace
  • getObtain plan information to link to AWS Marketplace
  • postCreate customer information to be linked to AWS Marketplace
  • getGet a list of customer information to be linked to AWS Marketplace
  • getGet customer information to be linked to AWS Marketplace
  • postSync AWS Marketplace customer information to SaaSus
  • getGet the link to create the AWS CloudFormation stack
  • postVerify Registration Token
  • getObtain product publication status from AWS Marketplace

API docs by Redocly

SaaSus AWS Marketplace API Schema (1.0.0)

SaaSus AWS Marketplace API Schema

awsMarketplace

Operations for AWS Marketplace resources

Get AWS Marketplace Settings

Get AWS Marketplace Settings.

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"

}

Update AWS Marketplace Settings

Update AWS Marketplace Settings.

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": "Error message"

}

Get AWS Marketplace Listing Status

Get AWS Marketplace Listing Status.

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"

}

Update AWS Marketplace Listing Status

Update AWS Marketplace Listing Status.

Authorizations:

Bearer

Request Body schema: application/json

listing_status required

string (AWS Marketplace Listing Status) 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": "Error message"

}

Obtain plan information to link to AWS Marketplace

Obtain plan information to link to AWS 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"

    }

  ]

}

Save plan information to be linked to AWSMarketplace

Save plan information to be linked to 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": "Error message"

}

Obtain plan information to link to AWS Marketplace

Obtain plan information to link to AWS Marketplace.

Authorizations:

Bearer

path Parameters

plan_name required

string Example: normal_plan_name_month AWS Marketplace linked plan name

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"

}

Create customer information to be linked to AWS Marketplace

Create customer information to be linked to 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"

}

Get a list of customer information to be linked to 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"

    }

  ]

}

Get customer information to be linked to AWS Marketplace

Get customer information to be linked to AWS Marketplace.

Authorizations:

Bearer

path Parameters

customer_identifier required

string Example: 123456789012 Customer 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"

}

Sync AWS Marketplace customer information to SaaSus

Sync AWS Marketplace customer information to SaaSus.

Authorizations:

Bearer

path Parameters

customer_identifier required

string Example: 123456789012 Customer 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": "Error message"

}

Get the link to create the AWS CloudFormation stack

Get the CloudFormation Quick Create link.

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"

}

Verify Registration Token

Verify 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": "Error message"

}

Obtain product publication status from AWS Marketplace

Retrieve the product's publication status from 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"

}