Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-02-17 15:11:17 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-02-17 15:11:17 +0300
commit4f8983ade80c0d71d4c8e6cc0d686c9cecf5e7d4 (patch)
tree3c51e09d9315acb8930c3c5383fb6384a3a841aa /doc/integration
parente191aabc8fd068233ac7b21e6f1299e2c371faba (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/integration')
-rw-r--r--doc/integration/partner_marketplace.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/doc/integration/partner_marketplace.md b/doc/integration/partner_marketplace.md
new file mode 100644
index 00000000000..a15457b5b0c
--- /dev/null
+++ b/doc/integration/partner_marketplace.md
@@ -0,0 +1,64 @@
+---
+stage: Fulfillment
+group: Commerce Integrations
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
+---
+
+# Marketplace partner integration guide
+
+GitLab supports automation for selected distribution marketplaces to process sales of GitLab products to authorized
+channel partners. Marketplace partners can use the GitLab Marketplace APIs to integrate their systems with GitLab to
+sell GitLab subscriptions on their site.
+
+This document's target audience is third-party developers for Marketplace partners.
+
+## How the Marketplace APIs work
+
+The Marketplace APIs are hosted in the [Customers Portal](https://customers.gitlab.com/). The Customers Portal allows
+individual customers to purchase and manage GitLab subscriptions and supports APIs for partners
+to make sales on behalf of their customers. The Customers Portal integrates with other GitLab services, including
+Zuora and Salesforce, to provide a task-oriented interface for users.
+
+The following example shows a typical purchase flow of request and response between the following components:
+
+- Customer
+- Marketplace partner system
+- Customers Portal
+- Zuora
+- Salesforce
+
+```mermaid
+sequenceDiagram
+ participant Customer
+ participant Marketplace partner system
+ participant Customers Portal
+ participant Zuora
+ participant Salesforce
+ Customer ->> Marketplace partner system: Place order to purchase GitLab subscription
+ Marketplace partner system ->> Customers Portal: Get OAuth token
+ Customers Portal ->> Marketplace partner system: Access token
+ Marketplace partner system ->> Customers Portal: Place order
+ Customers Portal ->> Zuora: Create Zuora subscription
+ Customers Portal ->> Salesforce: Create Salesforce objects
+ Zuora ->> Customers Portal: Success response with Zuora subscription data
+ Customers Portal ->> Marketplace partner system: Success response with order ID
+ Zuora ->> Customers Portal: Zuora callout event
+ Customers Portal ->> Customer: send license notification
+ Marketplace partner system ->> Customers Portal: Poll order status
+ Customers Portal ->> Marketplace partner system: Success response with order status
+```
+
+## Prerequisites
+
+Before a marketplace partner client can use the Marketplace API, GitLab must set up the following configurations for the client:
+
+1. Client credential. Marketplace APIs are secured with OAuth 2.0. A client credential is required to get the OAuth token.
+1. Invoice owner account in Zuora system. Required for invoice processing.
+1. Distributor account in Salesforce system.
+1. Trading partner account in Salesforce system.
+
+Interested GitLab Partners should contact their GitLab Partner Manager or email [`partnerorderops`](mailto:partnerorderops@gitlab.com).
+
+## Marketplace API Specification
+
+OpenAPI specs for the Marketplace APIs are available upon request. The specs will be made public before the end of Q1 2023.