Skip to content

Commit acf34f3

Browse files
CORE 1459 - Redirect pages to the new docs
1 parent d2771ca commit acf34f3

40 files changed

+95
-53
lines changed

_config.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ github_username: zype
1010
permalink: '/posts/:year/:month/:day/:title/'
1111
# Build settings
1212
markdown: kramdown
13+
plugins:
14+
- jekyll-redirect-from

_config_dev.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ github_username: zype
1010
permalink: '/posts/:year/:month/:day/:title/'
1111
# Build settings
1212
markdown: kramdown
13+
plugins:
14+
- jekyll-redirect-from

api_docs/3rd-party-CRM-integration.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22
layout: api
33
title: "3rd Party Payment Provider & Subscription Management Quickstart | Common API Examples"
44
permalink: /api_docs/3rd-party-crm-integration/
5+
redirect_to: https://docs.zype.com/v1.0/reference#3rd-party-payment-provider-subscription-management-quickstart
56
---
67

78
# 3rd Party Payment Provider & Subscription Management Quickstart
89

910
What does this solution do?
1011
Zype provides an effective way of importing and managing an external database of consumers within the Zype platform. This is useful if you are using a 3rd party payment processor to sell subscriptions or a 3rd party CRM tool to manage your customer database and would also like to import and track these customers in the Zype platform.
11-
12+
1213
Once imported into the Zype platform, benefits include ensuring these customers have access to content across all of your distribution endpoints via Universal login.
13-
14+
1415
This workflow involves use of Zype’s Consumer, Subscription, and Linked Devices APIs. This document provides details on how to integrate subscription customers and transactions processed via 3rd party payment processors.
1516

1617

@@ -29,46 +30,46 @@ In order to utilize Zype’s RESTful API service to implement 3rd party payment
2930
Importing and managing consumers and subscriptions stored in a 3rd party database is easy to do with Zype, typically requiring only three steps:
3031

3132
1. Create a consumer user in your own platform’s database
32-
33+
3334
2. Create corresponding Zype consumer user to match to your database consumer
34-
35+
3536
3. Create a subscription for the Zype consumer
3637

3738
### Step 1: Create a consumer user in your own platform’s database
3839

3940
Consumers are used to represent users in the Zype platform. Consumer records can be used to store basic user login information, including email, name and password. Consumers can also be used to store subscription information, and if credentials are supplied, process payments and subscriptions from Stripe or Braintree.
40-
41+
4142
Creating a consumer user in your database is typically handled prior to transaction processing, during your account sign up or account creation flow. This is not dependent on the Zype platform, but is required for importing or creating a consumer record in the Zype database.
4243

4344
### Step 2: Create the corresponding consumer user in Zype
4445

4546
Once you’ve created a consumer in your database, you should also create a consumer in the Zype platform via our Consumer API. This will ensure that you can track all consumers who are creating accounts via your 3rd party payment processors or CRMs, and that those consumers can have access to any subscription content they purchase directly through you.
46-
47+
4748
Consumer objects are generally used in the following ways in the Zype platform:
4849

4950
* To store subscription, transaction, entitlement, and payment information about users.
5051
* To enable linking a device for the user in order to access content on one of your OTT endpoints.
5152
* To optionally provide login capabilities for your platform. Depending on your use case this may not be required, but if you’d like to utilize login capabilities simply provide a password for consumers when they are created.
5253

5354
The minimum required fields to create a user is their email address. You can also supply additional information including the consumer’s name, birthday, or gender by supplying values in the POST request. Although optional, typically all consumer objects include passwords upon creation (to enable login / authentication across your content distribution endpoints).
54-
55+
5556
Once you create a consumer in Zype, you’ll want to create a relational record for the consumer between Zype and your own database. We suggest using the Zype consumer ID for this purpose. The consumer ID of a Zype created consumer is returned upon successful creation via API. (example consumer_id value: 54579a634c61450389000000)
56-
57-
To create consumers via API, you will need to supply your admin API key in the API request.
57+
58+
To create consumers via API, you will need to supply your admin API key in the API request.
5859

5960
Consumer API Endpoint
6061
POST - https://api.zype.com/consumers/
61-
62+
6263
Example Request:
63-
{% highlight xml %}
64+
{% highlight xml %}
6465
curl https://api.zype.com/consumers/ \
6566
-d api_key="[YOUR ADMIN KEY]" \
6667
-d consumer[email]="[email protected]" \
6768
-d consumer[name]="Example User" \
6869
-d consumer[password]="ExamplePassword"
6970

7071
Example Response:
71-
72+
7273
{
7374
"response": {
7475
"_id": "54579a634c61450389000000",
@@ -81,37 +82,37 @@ Example Response:
8182
"updated_at": "2014-11-03T15:08:19.675Z"
8283
}
8384
}
84-
{% endhighlight %}
85+
{% endhighlight %}
8586
For a full listed of supported API commands please visit our API documentation: [Zype Consumer API Documentation](http://dev.zype.com/api_docs/consumers/)
8687

8788

8889
### Step 3: Create a subscription for a Zype consumer
8990

90-
Subscriptions are used to track that a consumer has subscribed to content on your platform and should have entitlement to your premium subscription library. There are three types of subscriptions available: Basic, Stripe or Braintree.
91-
91+
Subscriptions are used to track that a consumer has subscribed to content on your platform and should have entitlement to your premium subscription library. There are three types of subscriptions available: Basic, Stripe or Braintree.
92+
9293
Basic subscriptions are used to indicate that a user has subscribed to your content without having a Zype integrated payment provider to process payment. For any subscriptions purchased through your 3rd party payment processor, you’ll create Basic subscriptions via Zype’s Subscription API.
9394

9495
Stripe and Braintree subscriptions require a payment token be provided from the respective provider when creating the subscription. Zype will then process the payment through the respective provider on your behalf.
95-
96+
9697
Subscriptions should be created after your users has provided payment details. If you would like to manage payment processing yourself use a “basic” subscription which will only track that a user is subscribed to a plan. Stripe or Braintree subscriptions can be utilized if you have Zype manage subscriptions on your behalf via our embeddable widgets.
97-
98+
9899
Once a consumer purchases via your 3rd party payment processor, you’ll want to create a Basic subscription in the Zype platform. After creating the Basic subscription, you should create a relational record between the subscription record in Zype and your own database. We suggest using the Zype subscription ID for this purpose. The subscription ID of a Zype created subscription is returned upon successful creation of the subscription. (example subscription_id: 54579a634c61450389000000)
99-
100+
100101
To create subscriptions you will need to supply your admin API key in the API request. You will also need to have a consumer and plan set up in the Zype platform to subscribe to.
101102

102103
Subscription API Endpoint
103-
POST - https://api.zype.com/subscriptions
104-
104+
POST - https://api.zype.com/subscriptions
105+
105106
Example Request:
106-
{% highlight xml %}
107+
{% highlight xml %}
107108
curl https://api.zype.com/subscriptions \
108109
-d api_key="[YOUR ADMIN KEY]" \
109110
-d subscription[third_party_id]=[THIRD PARTY ID IN YOUR PLAN]\
110111
-d subscription[plan_id]="54579a634c61450389000000" \
111112
-d subscription[consumer_id]="54579a634c61450389000000" \
112113

113114
Example Response:
114-
115+
115116
{
116117
"response": {
117118
"_id": "54579a634c61450389000000",
@@ -128,12 +129,12 @@ Example Response:
128129
"updated_at": "2014-11-03T15:08:19.675Z"
129130
}
130131
}
131-
{% endhighlight %}
132-
For a full list of supported API commands please visit our API documentation:
132+
{% endhighlight %}
133+
For a full list of supported API commands please visit our API documentation:
133134
[Zype Subcription API Documentation](http://dev.zype.com/api_docs/subscriptions/)
134135

135136

136137
Reference Materials:
137-
138+
138139
API Documentation: [Zype API Documentation](http://dev.zype.com/api_docs/intro/)
139140
API Keys: [Zype Property API Keys](https://admin.zype.com/api_keys)

api_docs/ad_tag.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: api
33
title: Zype Developer Portal | Ad Tags
44
permalink: /api_docs/ad_tags/
5+
redirect_to: https://docs.zype.com/reference#ad-tags
56
---
67

78
## Ad Tags

api_docs/analytics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: api
33
title: Zype Developer Portal | Analytics
44
permalink: /api_docs/analytics/
5+
redirect_to: https://docs.zype.com/reference#stream-hours
56
---
67

78
## Analytics

api_docs/apps.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: api
33
title: Zype Developer Portal | Apps
44
permalink: /api_docs/apps/
5+
redirect_to: https://docs.zype.com/reference#apps
56
---
67

78
# Apps
@@ -32,7 +33,7 @@ Parameter | Function | Type
3233
app_key | The app key | String
3334

3435
## App Object
35-
App profiles vary by the type of application.
36+
App profiles vary by the type of application.
3637

3738
```
3839
{

api_docs/categories.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: api
33
title: Zype Developer Portal | Categories
44
permalink: /api_docs/categories/
5+
redirect_to: https://docs.zype.com/reference#categories
56
---
67

78
## Categories
@@ -86,4 +87,4 @@ id | ID of the record to delete (Example: 540731274c616e047a000000) | String
8687
"no"
8788
]
8889
}
89-
</pre>
90+
</pre>

api_docs/consumers.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: api
33
title: Zype Developer Portal | Consumers
44
permalink: /api_docs/consumers/
5+
redirect_to: https://docs.zype.com/reference#consumers
56
---
67

78
## Consumers
@@ -120,4 +121,4 @@ id | ID of the record to be deleted. Example: 540731274c616e047a000000 | String
120121
]
121122
"updated_at": "2014-11-03T15:08:19.675Z"
122123
}
123-
</pre>
124+
</pre>

api_docs/content_rules_category.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: api
33
title: Zype Developer Portal | Category Content Rules
44
permalink: /api_docs/content_rules_category/
5+
redirect_to: https://docs.zype.com/reference#category-content-rules
56
---
67

78
## Category Content Rules

api_docs/content_rules_playlist.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
layout: api
33
title: Zype Developer Portal | Playlist Content Rules
44
permalink: /api_docs/content_rules_playlist/
5+
redirect_to: https://docs.zype.com/reference#playlist-content-rules
56
---
67

78
## Playlist Content Rules

0 commit comments

Comments
 (0)