Skip to content

Commit 53cc8a1

Browse files
authored
Update PP API docs (#1564)
1 parent 955865c commit 53cc8a1

File tree

9 files changed

+439
-419
lines changed

9 files changed

+439
-419
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
export const PartnerApiIcon = ({ fill, background, ...rest }) => (
2+
<svg
3+
width="30"
4+
height="30"
5+
viewBox="0 0 30 30"
6+
fill="none"
7+
xmlns="http://www.w3.org/2000/svg"
8+
{...rest}
9+
>
10+
<rect width="30" height="30" rx="4" fill={background || "#AC13A4"} />
11+
<path
12+
d="M20 23H25V21C25.0017 20.3753 24.8082 19.7657 24.4467 19.2562C24.0852 18.7467 23.5737 18.3627 22.9835 18.1579C22.3933 17.9531 21.7539 17.9377 21.1546 18.1137C20.5552 18.2898 20.0257 18.6486 19.64 19.14M20 23L19.64 19.14M20 23H10M20 23V21C20 20.34 19.87 19.72 19.64 19.14M19.64 19.14C19.2681 18.2137 18.6274 17.4199 17.8005 16.8608C16.9736 16.3017 15.9982 16.0029 15 16.0029C14.0018 16.0029 13.0265 16.3017 12.1995 16.8608C11.3726 17.4199 10.7319 18.2137 10.36 19.14M10 23H5.00001V21C4.99837 20.3753 5.19179 19.7657 5.55328 19.2562C5.91477 18.7467 6.4263 18.3627 7.01649 18.1579C7.60668 17.9531 8.24607 17.9377 8.84546 18.1137C9.44485 18.2898 9.97433 18.6486 10.36 19.14M10 23L10.36 19.14M10 23V21C10 20.34 10.13 19.72 10.36 19.14M18 10C18 10.7956 17.6839 11.5587 17.1213 12.1213C16.5587 12.6839 15.7957 13 15 13C14.2044 13 13.4413 12.6839 12.8787 12.1213C12.3161 11.5587 12 10.7956 12 10C12 9.20435 12.3161 8.44129 12.8787 7.87868C13.4413 7.31607 14.2044 7 15 7C15.7957 7 16.5587 7.31607 17.1213 7.87868C17.6839 8.44129 18 9.20435 18 10ZM24 13C24 13.5304 23.7893 14.0391 23.4142 14.4142C23.0391 14.7893 22.5304 15 22 15C21.4696 15 20.9609 14.7893 20.5858 14.4142C20.2107 14.0391 20 13.5304 20 13C20 12.4696 20.2107 11.9609 20.5858 11.5858C20.9609 11.2107 21.4696 11 22 11C22.5304 11 23.0391 11.2107 23.4142 11.5858C23.7893 11.9609 24 12.4696 24 13ZM10 13C10 13.5304 9.7893 14.0391 9.41422 14.4142C9.03915 14.7893 8.53044 15 8.00001 15C7.46958 15 6.96087 14.7893 6.5858 14.4142C6.21072 14.0391 6.00001 13.5304 6.00001 13C6.00001 12.4696 6.21072 11.9609 6.5858 11.5858C6.96087 11.2107 7.46958 11 8.00001 11C8.53044 11 9.03915 11.2107 9.41422 11.5858C9.7893 11.9609 10 12.4696 10 13Z"
13+
fill="none"
14+
stroke={fill || "white"}
15+
strokeWidth="2"
16+
strokeLinecap="round"
17+
strokeLinejoin="round"
18+
/>
19+
</svg>
20+
);

src/configs/containers.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,5 +160,9 @@
160160
"title": "Team Chat API"
161161
}
162162
]
163+
},
164+
{
165+
"category": "partner-program",
166+
"items": []
163167
}
164168
]

src/constants/cards.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import { DevConsoleToolsIcon } from "assets/icons/cards/DevConsoleTools";
1010
import { TextApiIcon } from "assets/icons/cards/TextAPI";
1111
import { BeginnerPathIcon } from "assets/icons/cards/BeginnerPath";
1212
import { AdvancedPathIcon } from "assets/icons/cards/AdvancedPath";
13+
import { PartnerApiIcon } from "assets/icons/cards/PartnerAPI";
1314

1415
export const cards = [
1516
{
@@ -72,6 +73,12 @@ export const cards = [
7273
copy: "Build products powered by advanced text operations.",
7374
image: <TextApiIcon />,
7475
},
76+
{
77+
title: "Partner API",
78+
link: "/partner-program",
79+
copy: "Manage Partner Program data and integrate it into your systems.",
80+
image: <PartnerApiIcon />,
81+
},
7582
];
7683

7784
export const devPaths = [

src/constants/header.js

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,14 @@ export const apis = [
3333
},
3434
{
3535
title: "Configuration API",
36-
description: "Manage resources",
36+
description: "Change license configuration",
3737
link: "/management/configuration-api",
3838
},
39+
{
40+
title: "Partner API",
41+
description: "Manage Partner data",
42+
link: "/partner-program",
43+
},
3944
];
4045

4146
export const sdks = [
@@ -56,9 +61,14 @@ export const sdks = [
5661
},
5762
{
5863
title: "Customer SDK",
59-
description: "Build a custom widget",
64+
description: "Create a custom widget",
6065
link: "/extending-chat-widget/customer-sdk",
6166
},
67+
{
68+
title: "Developer SDK",
69+
description: "Build in the Developer Program",
70+
link: "/getting-started/developer-sdk",
71+
},
6272
];
6373

6474
export const platform = {

src/pages/getting-started/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ The Platform provides you with <a href="https://platform.text.com/docs/monetizat
162162

163163
We want you to deliver well-designed and efficient apps for users. We put apps through the <a href="https://platform.text.com/docs/monetization/app-review-process" target="_blank">app review process</a> before they are published on the marketplace and provide developers with some guidelines that help improve apps and make them more attractive to customers.
164164

165-
The <a href="https://platform.text.com/docs/monetization/partner-program-api" target="_blank">Partner Program API</a> offered by Text allows you to build tools to help you use your data better and develop your business. Play with the API and decide what you want to create.
165+
The <a href="https://platform.text.com/docs/partner-program/partner-api/" target="_blank">Partner API</a> offered by Text allows you to build tools to help you use your data better and develop your business. Play with the API and decide what you want to create.
166166

167167
# Contact us
168168

src/pages/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ const cardsWrapperCss = css`
4747
justify-content: center;
4848
4949
> a {
50-
margin-bottom: 40px;
50+
margin: 20px;
5151
}
5252
5353
@media (min-width: 480px) {
54-
justify-content: space-between;
54+
justify-content: center;
5555
}
5656
`;
5757

src/pages/monetization/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ To withdraw such funds, follow the [standard withdrawal process](#standard-withd
5454
- You're the author of at least one paid application that features on <Placeholder id="LIVECHAT_MARKETPLACE_URL" />.
5555
- Your application was purchased and installed by a customer at least once.
5656

57-
## Partner Program API
57+
## Partner API
5858

59-
Our Partner Program API allows you to build your own tools that will help you make a better use of your data. Partner up with LiveChat, and grow your business with the leading customer service platform in the industry.
59+
Our Partner API allows you to build custom tools to make better use of your data. Partner with Text and grow your business with the industry’s leading customer service platform.
6060

61-
<SectionLink to={"/monetization/partner-program-api/"}>
62-
Partner Program API
61+
<SectionLink to={"/partner-program/partner-api/"}>
62+
Go to the Partner API
6363
</SectionLink>
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
weight: 1
3+
category: "partner-program"
4+
title: "Partner API Overview"
5+
tagline: "Manage your Partner Program data through dedicated APIs."
6+
desc: "Automate Partner Program operations by connecting to the Partner API."
7+
slug: "/partner-program/"
8+
---
9+
10+
# Introduction
11+
12+
The Partner API allows you to build tools that help you make better use of your data. It provides direct access to all features available in the Partner App, allowing you to fully automate your business operations.
13+
14+
## Use cases
15+
16+
Here are some of the most common use cases for the Partner API:
17+
18+
- Create and manage product licenses for your customers
19+
- Launch and track affiliate campaigns, and automatically optimize them based on performance
20+
- Pull your earnings information into custom analytics or reporting tools
21+
- Integrate customer data with your CRM, BI platform, or marketing systems
22+
23+
## Resources
24+
25+
### Account management
26+
27+
Manage your Partner account details and earnings.
28+
29+
<SectionLink to={"/partner-program/partner-api#account"}>
30+
See account methods
31+
</SectionLink>
32+
33+
### Affiliate Partner
34+
35+
Start affiliate campaigns and collect information on their performance.
36+
37+
<SectionLink to={"/partner-program/partner-api#affiliate-partner"}>
38+
See Affiliate Partner methods
39+
</SectionLink>
40+
41+
### Solution Partner
42+
43+
Create and manage product licenses of your customers.
44+
45+
<SectionLink to={"/partner-program/partner-api#solution-partner"}>
46+
See Solution Partner methods
47+
</SectionLink>

0 commit comments

Comments
 (0)