Register an application

Registers an application and displays it publicly in the App Store. Before you submit an application, read the App Store documentation.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json
name
required
string

Name of the application.

logoId
required
string <= 50 characters

File ID of the application logo.

authorName
required
string

Name of the application author.

tagline
required
string

Tagline of the application.

description
required
string

Detailed application description. This field accepts markdown and simple text.

permissions
required
Array of strings <operationId>

List of permissions that are available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum: "PostWebhookCredentialHash" "PostWebhook" "GetWebhook" "GetCustomer" "GetCustomerCollection" "GetInvoice" "GetInvoiceCollection" "GetPlan" "GetPlanCollection" "GetProduct" … 9 more
authorLogoId
string <= 50 characters

File ID of the author's logo.

properties
object

Defines settings that users can complete when they install the application. This field accepts JSON-schema drafts 4, 6, and 7.

Responses
201

Application registered.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
name
required
string

Name of the application.

logoId
required
string <= 50 characters

File ID of the application logo.

authorName
required
string

Name of the application author.

tagline
required
string

Tagline of the application.

description
required
string

Detailed application description. This field accepts markdown and simple text.

permissions
required
Array of strings <operationId>

List of permissions that are available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum: "PostWebhookCredentialHash" "PostWebhook" "GetWebhook" "GetCustomer" "GetCustomerCollection" "GetInvoice" "GetInvoiceCollection" "GetPlan" "GetPlanCollection" "GetProduct" … 9 more
id
string <= 50 characters

Application identifier string.

authorLogoId
string <= 50 characters

File ID of the author's logo.

status
string

Status of the application.

Enum: "pending-approval" "available" "disabled"
properties
object

Defines settings that users can complete when they install the application. This field accepts JSON-schema drafts 4, 6, and 7.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) or ApplicationInstanceLink (object) or LogoUrlLink (object) or AuthorLogoUrlLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

409

Conflict.

422

Invalid data sent.

post/applications
Request samples
application/json
{
  • "name": "string",
  • "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "authorName": "string",
  • "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "tagline": "string",
  • "description": "string",
  • "permissions": [
    ],
  • "properties": {
    }
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "authorName": "string",
  • "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "tagline": "string",
  • "description": "string",
  • "status": "pending-approval",
  • "permissions": [
    ],
  • "properties": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}