Skip to content

Commit c7ca1cc

Browse files
committed
CORE-1715 Change development site texts and main page - cloud video to video streaming
1 parent 90cfcc8 commit c7ca1cc

16 files changed

+101
-102
lines changed

Overview.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Overview
2-
IBM Cloud Video allows third-party clients to access IBM Cloud Video users' resources (data) via a HTTP-based (RESTful) API. It also provides a Broadcaster Library that is capable of broadcasting to a user's channel. Both the REST API and the Broadcaster Library uses the OAuth 2.0 protocol for authentication and authorization.
2+
IBM Video Streaming allows third-party clients to access IBM Video Streaming users' resources (data) via a HTTP-based (RESTful) API. It also provides a Broadcaster Library that is capable of broadcasting to a user's channel. Both the REST API and the Broadcaster Library uses the OAuth 2.0 protocol for authentication and authorization.
33

44
## Basic workflow
55
The basic workflow of a third-party Client is the following:
66

77
1. **Authorize the user:** Obtain and validate the user's credentials (username and password). The client must never store these credentials, only pass it to the server for authorization.
8-
2. **Obtain an access token:** If the user's credentials were entered correctly, the third-party client can obtain an access token. Once this token is received, it can be used to access the user's resources until the token expires or the user revokes it on the IBM Cloud Video website.
9-
3. **Access the user's resources:** The client can use Ustream's REST API or the IBM Cloud Video Broadcasting Library to access the user's resources (data) or to broadcast to the user's channel. The client authorizes itself using the access token, with methods described by the OAuth 2.0 Protocol Draft.
8+
2. **Obtain an access token:** If the user's credentials were entered correctly, the third-party client can obtain an access token. Once this token is received, it can be used to access the user's resources until the token expires or the user revokes it on the IBM Video Streaming website.
9+
3. **Access the user's resources:** The client can use Ustream's REST API or the IBM Video Streaming Broadcasting Library to access the user's resources (data) or to broadcast to the user's channel. The client authorizes itself using the access token, with methods described by the OAuth 2.0 Protocol Draft.
1010

1111
### Authorization Flows
1212
The OAuth 2.0 protocol provides several flows (workflows) for the first two phases. It depends on the type and architecture of the client which flow is the most suitable. The following flows are supported:
@@ -15,21 +15,20 @@ The OAuth 2.0 protocol provides several flows (workflows) for the first two phas
1515
* **Authorization code flow:** Suitable for third-party websites which contain a client and a server component. The user enters its credentials to a secure login webpage. After logging in, the browser is redirected to a special URL (defined by the client), passing an authorization code in the URL. The third-party server obtains the access token with another HTTP request in the background, using the authorization code. This method is more secure than the implicit flow if the third-party client has a client+server model. See the OAuth2 Draft for details.
1616

1717
### Endpoints
18-
The webpages and HTTP services invoked in during this authorization process are called Endpoints. IBM Cloud Video has the following endpoints:
18+
The webpages and HTTP services invoked in during this authorization process are called Endpoints. IBM Video Streaming has the following endpoints:
1919

2020
* **Authorization endpoint:** this is the webpage where the user enters his/her credentials.
2121
* **Token endpoint:** this is the HTTP service where the access token can be obtained in an authorization code flow (when using the implicit flow, the access token can be obtained directly from the authorization endpoint).
2222

2323
### Access tokens
24-
There are two types of access tokens: **Bearer tokens** and **MAC tokens.** They are equivalent in the sense that they can access the same resources on the IBM Cloud Video REST API. The difference is that while bearer tokens can be only used on encrypted channels (HTTPS), MAC tokens are suitable on non-encrypted channels as well.
24+
There are two types of access tokens: **Bearer tokens** and **MAC tokens.** They are equivalent in the sense that they can access the same resources on the IBM Video Streaming REST API. The difference is that while bearer tokens can be only used on encrypted channels (HTTPS), MAC tokens are suitable on non-encrypted channels as well.
2525

26-
If the client uses the IBM Cloud Video Broadcasting Library, it must use MAC tokens: the broadcasting is done on the RTMP protocol, which is unencrypted. If the client only uses the REST API, the bearer tokens are preferred because their usage is very simple and lightweight.
26+
If the client uses the IBM Video Streaming Broadcasting Library, it must use MAC tokens: the broadcasting is done on the RTMP protocol, which is unencrypted. If the client only uses the REST API, the bearer tokens are preferred because their usage is very simple and lightweight.
2727

2828
Bearer tokens and MAC tokens can be obtained in the same way: the authorization endpoint has a token type parameter, so the client can specify what kind of token it wants to create.
2929

3030
### Token scopes, expiration
31-
By default, access tokens have a limited lifetime (they expire in a day) and can access only a limited amount of resources. In the authorization process the client can request extra permissions (scopes) from the user to overcome these limitations. These requests are shown to the user on the authorization endpoint. IBM Cloud Video currently supports the following scopes:
31+
By default, access tokens have a limited lifetime (they expire in a day) and can access only a limited amount of resources. In the authorization process the client can request extra permissions (scopes) from the user to overcome these limitations. These requests are shown to the user on the authorization endpoint. IBM Video Streaming currently supports the following scopes:
3232

3333
* **Offline scope:** If this scope is enabled, the access token never expires.
34-
* **Broadcaster scope:** If this Scope is enabled, the access token can be used for broadcasting with the IBM Cloud Video Broadcasting Library. This scope are enabled only for MAC tokens.
35-
34+
* **Broadcaster scope:** If this Scope is enabled, the access token can be used for broadcasting with the IBM Video Streaming Broadcasting Library. This scope are enabled only for MAC tokens.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
IBM Cloud Video Enterprise Channel API Documentation
1+
IBM Video Streaming Enterprise Channel API Documentation
22
=======
33

44
https://developers.video.ibm.com/

_posts/2015-09-01-getting-started.html

+21-21
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@
66
categoryItemType: documentation
77
categoryItemIsShown: 1
88
categoryItemWidth: 12
9-
categoryItemDescription: IBM Cloud Video allows third-party clients to access IBM Cloud Video users' resources (data) via a HTTP-based (RESTful) API. It also provides a Broadcaster Library that is capable of broadcasting to a user's channel. Both the REST API and the Broadcaster Library uses the OAuth 2.0 protocol for authentication and authorization.
9+
categoryItemDescription: IBM Video Streaming allows third-party clients to access IBM Video Streaming users' resources (data) via a HTTP-based (RESTful) API. It also provides a Broadcaster Library that is capable of broadcasting to a user's channel. Both the REST API and the Broadcaster Library uses the OAuth 2.0 protocol for authentication and authorization.
1010
categoryItemLabel: Read the documentation
1111
---
1212
<article data-sidenav="sidenav">
1313
<section>
1414
<h2>Overview</h2>
15-
<p>IBM Cloud Video allows third-party clients to access IBM Cloud Video users&#39; resources (data) via a HTTP-based (RESTful) API. It also provides a Broadcaster Library that is capable of broadcasting to a user&#39;s channel. Both the REST API and the Broadcaster Library uses the OAuth 2.0 protocol for authentication and authorization.</p>
15+
<p>IBM Video Streaming allows third-party clients to access IBM Video Streaming users&#39; resources (data) via a HTTP-based (RESTful) API. It also provides a Broadcaster Library that is capable of broadcasting to a user&#39;s channel. Both the REST API and the Broadcaster Library uses the OAuth 2.0 protocol for authentication and authorization.</p>
1616

1717

1818

1919
<h3>Basic workflow</h3>
2020
<p>The basic workflow of a third-party Client is the following:</p>
2121
<ol>
2222
<li><strong>Authorize the user:</strong> Obtain and validate the user&#39;s credentials (username and password). The client must never store these credentials, only pass it to the server for authorization.</li>
23-
<li><strong>Obtain an access token:</strong> If the user&#39;s credentials were entered correctly, the third-party client can obtain an access token. Once this token is received, it can be used to access the user&#39;s resources until the token expires or the user revokes it on the IBM Cloud Video website.</li>
24-
<li><strong>Access the user&#39;s resources:</strong> The client can use Ustream&#39;s REST API or the IBM Cloud Video Broadcasting Library to access the user&#39;s resources (data) or to broadcast to the user&#39;s channel. The client authorizes itself using the access token, with methods described by the OAuth 2.0 Protocol Draft.</li>
23+
<li><strong>Obtain an access token:</strong> If the user&#39;s credentials were entered correctly, the third-party client can obtain an access token. Once this token is received, it can be used to access the user&#39;s resources until the token expires or the user revokes it on the IBM Video Streaming website.</li>
24+
<li><strong>Access the user&#39;s resources:</strong> The client can use Ustream&#39;s REST API or the IBM Video Streaming Broadcasting Library to access the user&#39;s resources (data) or to broadcast to the user&#39;s channel. The client authorizes itself using the access token, with methods described by the OAuth 2.0 Protocol Draft.</li>
2525
</ol>
2626

2727

@@ -37,7 +37,7 @@ <h3>Authorization Flows</h3>
3737

3838

3939
<h3>Endpoints</h3>
40-
<p>The webpages and HTTP services invoked in during this authorization process are called endpoints. IBM Cloud Video has the following endpoints:</p>
40+
<p>The webpages and HTTP services invoked in during this authorization process are called endpoints. IBM Video Streaming has the following endpoints:</p>
4141
<ul>
4242
<li><strong>Authorization endpoint:</strong> this is the webpage where the user enters his/her credentials.</li>
4343
<li><strong>Token endpoint:</strong> this is the HTTP service where the access token can be obtained in an authorization code flow (when using the implicit flow, the access token can be obtained directly from the authorization endpoint).</li>
@@ -46,16 +46,16 @@ <h3>Endpoints</h3>
4646

4747

4848
<h3>Access tokens</h3>
49-
<p>There are two types of access tokens: <strong>Bearer tokens</strong> and <strong>MAC tokens.</strong> They are equivalent in the sense that they can access the same resources on the IBM Cloud Video REST API. The difference is that while bearer tokens can be only used on encrypted channels (HTTPS), MAC tokens are suitable on non-encrypted channels as well.</p>
50-
<p>If the client uses the IBM Cloud Video Broadcasting Library, it must use MAC tokens: the broadcasting is done on the RTMP protocol, which is unencrypted. If the client only uses the REST API, the bearer tokens are preferred because their usage is very simple and lightweight.</p>
49+
<p>There are two types of access tokens: <strong>Bearer tokens</strong> and <strong>MAC tokens.</strong> They are equivalent in the sense that they can access the same resources on the IBM Video Streaming REST API. The difference is that while bearer tokens can be only used on encrypted channels (HTTPS), MAC tokens are suitable on non-encrypted channels as well.</p>
50+
<p>If the client uses the IBM Video Streaming Broadcasting Library, it must use MAC tokens: the broadcasting is done on the RTMP protocol, which is unencrypted. If the client only uses the REST API, the bearer tokens are preferred because their usage is very simple and lightweight.</p>
5151
<p>Bearer tokens and MAC tokens can be obtained in the same way: the authorization endpoint has a token type parameter, so the client can specify what kind of token it wants to create.</p>
5252

5353

5454

5555
<h3>Token scopes, expiration</h3>
56-
<p>By default, access tokens have a limited lifetime (they expire in a day) and can access only a limited amount of resources. In the authorization process the client can request extra permissions (scopes) from the user to overcome these limitations. These requests are shown to the user on the authorization endpoint. IBM Cloud Video currently supports the following scope:</p>
56+
<p>By default, access tokens have a limited lifetime (they expire in a day) and can access only a limited amount of resources. In the authorization process the client can request extra permissions (scopes) from the user to overcome these limitations. These requests are shown to the user on the authorization endpoint. IBM Video Streaming currently supports the following scope:</p>
5757
<ul>
58-
<li><strong>Broadcaster scope:</strong> If this scope is enabled, the access token can be used for broadcasting with the IBM Cloud Video Broadcasting Library. This scope can only be used with MAC tokens.</li>
58+
<li><strong>Broadcaster scope:</strong> If this scope is enabled, the access token can be used for broadcasting with the IBM Video Streaming Broadcasting Library. This scope can only be used with MAC tokens.</li>
5959
</ul>
6060
</section>
6161

@@ -120,7 +120,7 @@ <h6>Supported OAuth 2.0 standard parameters</h6>
120120
</tr>
121121
</table>
122122

123-
<h6>IBM Cloud Video specific extra parameters</h6>
123+
<h6>IBM Video Streaming specific extra parameters</h6>
124124
<table class="table responsive">
125125
<tr>
126126
<th>parameter</th>
@@ -138,7 +138,7 @@ <h6>IBM Cloud Video specific extra parameters</h6>
138138
<td><strong>device_name</strong></td>
139139
<td>string</td>
140140
<td>OPTIONAL</td>
141-
<td>Full product name of the Client device or application. It is used for easy identification of the OAuth2 Token. The User will be able to review which Clients are connected to his/her account, and revoke these grants on the IBM Cloud Video website.</td>
141+
<td>Full product name of the Client device or application. It is used for easy identification of the OAuth2 Token. The User will be able to review which Clients are connected to his/her account, and revoke these grants on the IBM Video Streaming website.</td>
142142
</tr>
143143
<tr>
144144
<td><strong>display</strong></td>
@@ -204,19 +204,19 @@ <h6>Result</h6>
204204
</tr>
205205
<tr>
206206
<td><strong>access_token</strong></td>
207-
<td>Access Token (40 character length, hexa encoded sha1 hash). Referred as <em>macId</em> in the IBM Cloud Video Broadcaster Library.</td>
207+
<td>Access Token (40 character length, hexa encoded sha1 hash). Referred as <em>macId</em> in the IBM Video Streaming Broadcaster Library.</td>
208208
</tr>
209209
<tr>
210210
<td><strong>expires_in</strong></td>
211211
<td>The current lifetime of the token in seconds.</td>
212212
</tr>
213213
<tr>
214214
<td><strong>mac_key</strong></td>
215-
<td>MAC secret (40 character length, hexa encoded sha1 hash). Referred as <em>macSecret</em> in the IBM Cloud Video Broadcaster Library.</td>
215+
<td>MAC secret (40 character length, hexa encoded sha1 hash). Referred as <em>macSecret</em> in the IBM Video Streaming Broadcaster Library.</td>
216216
</tr>
217217
<tr>
218218
<td><strong>created_at</strong></td>
219-
<td>UTC timestamp of the creation datetime. Referred as <em>macIssueTime</em> in the IBM Cloud Video Broadcaster Library.</td>
219+
<td>UTC timestamp of the creation datetime. Referred as <em>macIssueTime</em> in the IBM Video Streaming Broadcaster Library.</td>
220220
</tr>
221221
<tr>
222222
<td><strong>mac_algorithm</strong></td>
@@ -356,13 +356,13 @@ <h3>Resource Owner Password Credentials flow</h3>
356356
<td><strong>username</strong></td>
357357
<td>string</td>
358358
<td>REQUIRED</td>
359-
<td>IBM Cloud Video username</td>
359+
<td>IBM Video Streaming username</td>
360360
</tr>
361361
<tr>
362362
<td><strong>password</strong></td>
363363
<td>string</td>
364364
<td>REQUIRED</td>
365-
<td>IBM Cloud Video password</td>
365+
<td>IBM Video Streaming password</td>
366366
</tr>
367367
<tr>
368368
<td><strong>device_name</strong></td>
@@ -407,11 +407,11 @@ <h6>Response</h6>
407407
</tr>
408408
<tr>
409409
<td><strong>mac_key</strong></td>
410-
<td>MAC secret (40 character length, hexa encoded sha1 hash). Referred as macSecret in the IBM Cloud Video Broadcaster Library.</td>
410+
<td>MAC secret (40 character length, hexa encoded sha1 hash). Referred as macSecret in the IBM Video Streaming Broadcaster Library.</td>
411411
</tr>
412412
<tr>
413413
<td><strong>created_at</strong></td>
414-
<td>UTC timestamp of the creation datetime. Referred as macIssueTime in the IBM Cloud Video Broadcaster Library.</td>
414+
<td>UTC timestamp of the creation datetime. Referred as macIssueTime in the IBM Video Streaming Broadcaster Library.</td>
415415
</tr>
416416
<tr>
417417
<td><strong>mac_algorithm</strong></td>
@@ -484,11 +484,11 @@ <h6>Response</h6>
484484
</tr>
485485
<tr>
486486
<td><strong>mac_key</strong></td>
487-
<td>MAC tokens only: MAC secret (40 character length, hexa encoded sha1 hash). Referred as macSecret in the IBM Cloud Video Broadcaster Library.</td>
487+
<td>MAC tokens only: MAC secret (40 character length, hexa encoded sha1 hash). Referred as macSecret in the IBM Video Streaming Broadcaster Library.</td>
488488
</tr>
489489
<tr>
490490
<td><strong>created_at</strong></td>
491-
<td>UTC timestamp of the creation datetime. Referred as macIssueTime in the IBM Cloud Video Broadcaster Library.</td>
491+
<td>UTC timestamp of the creation datetime. Referred as macIssueTime in the IBM Video Streaming Broadcaster Library.</td>
492492
</tr>
493493
<tr>
494494
<td><strong>mac_algorithm</strong></td>
@@ -655,4 +655,4 @@ <h3>Creating a channel (POST)</h3>
655655
{"channel":{"id":"13091307","title":"Whatever Test 1234","url":"whatever-test-1234","tiny_url":"http://ustre.am/SVE7"}}
656656
</code></pre>
657657
</section>
658-
</article>
658+
</article>

0 commit comments

Comments
 (0)