You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/cloud/guides/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Open Cloud guides
3
3
description: In addition to using Engine and Studio tools to create experiences on Roblox, you can automate your internal workflows, improve your efficiency creating content, and support your experience operation needs from the web.
4
4
---
5
5
6
-
The Open Cloud v1 and v2 resource guides provide detailed walkthroughs for popular Open Cloud use cases, such as [retrieving user inventories](inventory.md), [sending announcements](usage-messaging.md), or [using webhooks](../webhooks/webhook-notifications.md) to notify your apps of certain events.
6
+
The Open Cloud resource guides provide detailed walkthroughs for popular Open Cloud use cases, such as [retrieving user inventories](inventory.md), [sending announcements](usage-messaging.md), or [using webhooks](../webhooks/webhook-notifications.md) to notify your apps of certain events.
7
7
8
8
Guides often include sample code in Python or Node.js and are a great way to get started, understand a resource, and spark ideas for your own usage.
Copy file name to clipboardExpand all lines: content/en-us/cloud/index.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,20 +3,23 @@ title: Cloud API reference
3
3
description: Get comprehensive API reference documentation for Open Cloud.
4
4
---
5
5
6
-
With Open Cloud, you can access Roblox resources through standard [REST](https://en.wikipedia.org/wiki/REST) APIs, which lets you build everything from command line automation tools to complex web apps. The Open Cloud APIs support HTTPS and use [API keys](./auth/api-keys.md) or [OAuth 2.0](./auth/oauth2-overview.md) for authentication. You can update experiences, restart servers, work with your data stores and memory stores, manage user restrictions, list inventory items, and much, much more.
6
+
With Open Cloud, you can access Roblox resources through standard [REST](https://en.wikipedia.org/wiki/REST) APIs, which lets you build everything from command line automation tools to complex web apps. You can update experiences, restart servers, work with your data stores and memory stores, manage user restrictions, list inventory items, and much, much more.
7
7
8
8
## About this reference
9
9
10
10
This reference documentation is broken into two sections:
11
11
12
-
- A [feature-based section](features/accounts.md)that categorizes APIs by use case (Avatars, Game Passes, Users, etc.).
13
-
- A [section that separates endpoints by system](/cloud/reference/DataStore#Cloud_ListDataStores) (Open Cloud v2, v1, or legacy).
12
+
- A [section that separates endpoints by feature](./features/accounts.md) (Avatars, Game Passes, Users, etc.)
13
+
- A [section that separates endpoints by authentication type](./api/toolbox-service.md) (Open Cloud or cookie-based)
14
14
15
15
**Both sections** contain the full list of available API endpoints; use whichever helps you find what you need.
16
16
17
-
Whenever possible, use Open Cloud v2, Open Cloud v1, or [legacy endpoints that support API key and/or OAuth 2.0 authentication](legacy.md). These APIs have strong stability guarantees and regularly add new resources.
17
+
Whenever possible, use the Open Cloud APIs. These APIs support HTTPS and use [API keys](./auth/api-keys.md)or [OAuth 2.0](./auth/oauth2-overview.md) for authentication. They have strong stability guarantees and regular releases.
18
18
19
-
Legacy API endpoints with cookie authentication can incorporate breaking changes without notice and have minimal stability guarantees. We don't recommend them for production applications. The legacy API has been known by various names over the years, including the Roblox site API, the web API, and the classic API.
19
+
- Open Cloud v2 APIs use certain resource-oriented design patterns. For more information, see [Patterns](./reference/patterns.md).
20
+
- Some other Open Cloud APIs share similar resource-oriented patterns, but are not guaranteed to strictly follow all of them.
21
+
22
+
Legacy APIs use cookie-based authentication, can incorporate breaking changes without notice, and have minimal stability guarantees. We don't recommend them for production applications.
20
23
21
24
<Alertseverity="info">
22
25
Roblox also offers [webhooks](./webhooks/webhook-notifications.md), which can notify your applications when certain events occur, such as refunds or changes to subscriptions.
@@ -30,4 +33,4 @@ Roblox also offers [webhooks](./webhooks/webhook-notifications.md), which can no
30
33
31
34
1. Test API calls using tools like [Postman](https://www.postman.com) with [OpenAPI descriptions](./reference/openapi.md) or the [OAuth 2.0 sample app](./auth/oauth2-sample.md).
32
35
1. Review the [resource guides](./guides/index.md) for end-to-end walkthroughs of using certain APIs.
33
-
1. Explore the left navigation for the full list of Open Cloud v2 and v1 resources, [common API patterns](./reference/patterns.md), [types](./reference/types.md), and [error codes](./reference/errors.md).
36
+
1. Explore the left navigation for the full list of features, [common API patterns](./reference/patterns.md), [types](./reference/types.md), and [error codes](./reference/errors.md).
![rbx-open-source-docs[bot]](https://avatars.githubusercontent.com/in/357490?v=4&size=40){kind=avatar}
0 commit comments