From 64bc5c8136cdc6a0a76bc95883266f33e5c47a46 Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Thu, 18 Aug 2022 15:50:09 -0700 Subject: [PATCH 1/9] Remove API subnav --- src/_layouts/main.html | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/_layouts/main.html b/src/_layouts/main.html index ea897318b7..fca0ce1bfc 100644 --- a/src/_layouts/main.html +++ b/src/_layouts/main.html @@ -14,8 +14,6 @@ {% include menu/menu-glossary.html %} {% elsif currentPage[1] == 'partners' %} {% include menu/menu-partners.html %} - {% elsif currentPage[1] == 'config-api' %} - {% include menu/menu-config-api.html %} {% else %} {% include menu/menu.html %} {% endif %} From 2da86cba0bd96d3a7fc803d34241eff5e670983a Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Thu, 18 Aug 2022 16:04:23 -0700 Subject: [PATCH 2/9] Hide old Config API nav --- src/_data/sidenav/main.yml | 15 +++++++++++++++ src/_includes/icons/api.svg | 5 +++++ src/_includes/menu/menu.html | 4 ++-- 3 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 src/_includes/icons/api.svg diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index 2384dcb427..e276f356a0 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -407,3 +407,18 @@ sections: title: Prod and Testing Environments in Segment - path: /segment-app/verify-email-address title: Verifying Your Email Address +- section_title: API + section: + - path: /config-api + title: Config API overview + - path: /config-api/api-design + title: API design + - path: /config-api/authentication + title: Authentication + - path: /config-api/fql + title: Destination Filter Query Language + - path: "https://reference.segmentapis.com/" + title: Reference + menu_icon: new-tab + - path: /config-api/tutorial-javascript-google-analytics + title: Creating a Javascript web source and Google Analytics destination \ No newline at end of file diff --git a/src/_includes/icons/api.svg b/src/_includes/icons/api.svg new file mode 100644 index 0000000000..527f27eff1 --- /dev/null +++ b/src/_includes/icons/api.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/src/_includes/menu/menu.html b/src/_includes/menu/menu.html index d881cf17df..d847716a8d 100644 --- a/src/_includes/menu/menu.html +++ b/src/_includes/menu/menu.html @@ -4,7 +4,7 @@
{% include menu/menu-primary.html %} -
diff --git a/src/_sass/components/_markdown.scss b/src/_sass/components/_markdown.scss index dd1abc5847..f0befa2c1b 100644 --- a/src/_sass/components/_markdown.scss +++ b/src/_sass/components/_markdown.scss @@ -152,13 +152,16 @@ top: 0; left: 0; } + div.highlighter-rouge { margin: 15px auto; position: relative; } + table { margin: 15px auto; } + &>ul, ol { margin-top: 0; @@ -213,6 +216,14 @@ line-height: 1.5; padding: 24px; } + + img { + border: none; + display: inline; + margin: 0; + vertical-align: inherit; + } + } thead { @@ -309,7 +320,7 @@ } //a[target="_blank"]:not(.reference-button):after { - //content: url("/docs/images/external-link-alt-solid.svg"); +//content: url("/docs/images/external-link-alt-solid.svg"); // margin-left: 4px; //} @@ -406,12 +417,14 @@ div.highlighter-rouge { right: 0; border-radius: 0 0.15rem; width: 40px; + img { width: 16px; margin: 0; border: none; border-radius: 0px; } + img:hover { filter: invert(65%) sepia(9%) saturate(784%) hue-rotate(192deg) brightness(91%) contrast(87%); transition: 0.2s ease-out; @@ -422,7 +435,7 @@ div.highlighter-rouge { } } - .green{ + .green { background-color: #BAE5D5; content: "copied!"; } diff --git a/src/api/index.md b/src/api/index.md index cbe935becd..a705db7463 100644 --- a/src/api/index.md +++ b/src/api/index.md @@ -7,3 +7,17 @@ All CRUD endpoints in the API follow REST conventions and use standard HTTP meth For more information, see the [Segment Public API documentation](#). +## Config API vs Public API +The Public API includes the following benefits over the Config API: + +| Benefit | Details | +| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Future Enhancements | Future improvements will be added to the Public API only. | +| Improved error handling | The Public API offers more specific error messages, for faster issue resolution. | +| Versioning | Each endpoint on the Public API can have multiple versions. Stable versions can coexist with beta or alpha versions. | +| Higher rate limits | The Public API can offer higher rate limits when needed or different rate limits per endpoint or token. | +| Improved architecture | The Public API is built with improved security, checks for authentication, authorization, input validation, HTTPS exposed services, auto-scaling, and more in mind. | +| Cleaner mapping | The Public API uses unique IDs for reference, in place of slugs in the Config API. Unique IDs are, by design, unique. | +| Improved ease of use | | +| Available in Europe | | +| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate | \ No newline at end of file From cdd70f351f143007fa4ac0b3a7473809ff9754ef Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Fri, 2 Sep 2022 12:00:44 -0700 Subject: [PATCH 7/9] Update URL [netlify-build] --- src/api/index.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/api/index.md b/src/api/index.md index a705db7463..7e93d6cb3b 100644 --- a/src/api/index.md +++ b/src/api/index.md @@ -5,7 +5,12 @@ The Segment Public API helps you manage your Segment workspaces and its resource All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a workspace. -For more information, see the [Segment Public API documentation](#). +{% include components/reference-button.html + href="https://docs.segmentapis.com" + icon="media/programming.svg" + title="Segment Public API Documentation" + description="Research and test the Public API's available endpoints." +%} ## Config API vs Public API The Public API includes the following benefits over the Config API: @@ -18,6 +23,5 @@ The Public API includes the following benefits over the Config API: | Higher rate limits | The Public API can offer higher rate limits when needed or different rate limits per endpoint or token. | | Improved architecture | The Public API is built with improved security, checks for authentication, authorization, input validation, HTTPS exposed services, auto-scaling, and more in mind. | | Cleaner mapping | The Public API uses unique IDs for reference, in place of slugs in the Config API. Unique IDs are, by design, unique. | -| Improved ease of use | | -| Available in Europe | | +| Available in Europe | The Public API is accessible to both US and EU-based workspaces. | | Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate | \ No newline at end of file From 6d29a482522c4629b39eb43148dd067f702e406b Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Fri, 2 Sep 2022 14:18:47 -0700 Subject: [PATCH 8/9] Config API -> Public API [netlify-build] --- src/_data/glossary.yml | 2 +- src/_includes/menu/menu.html | 13 ------------- src/connections/destinations/add-destination.md | 12 ++++++------ .../destinations/repeater-migration.md | 4 ++-- .../functions/destination-functions.md | 2 +- src/connections/storage/catalog/aws-s3/index.md | 2 +- src/connections/storage/warehouses/faq.md | 2 +- .../usage-and-billing/account-management.md | 2 +- src/partners/checklist.md | 3 +-- src/partners/enable-with-segment.md | 8 ++++---- src/partners/spec.md | 2 +- src/privacy/user-deletion-and-suppression.md | 17 ++++++++--------- src/protocols/apis-and-extensions/index.md | 6 +++--- .../apis-and-extensions/typewriter-v7.md | 4 ++-- src/protocols/apis-and-extensions/typewriter.md | 4 +--- src/protocols/tracking-plan/create.md | 2 +- src/segment-app/iam/concepts.md | 2 +- 17 files changed, 35 insertions(+), 52 deletions(-) diff --git a/src/_data/glossary.yml b/src/_data/glossary.yml index 36aff1cbba..0960903d51 100644 --- a/src/_data/glossary.yml +++ b/src/_data/glossary.yml @@ -2,7 +2,7 @@ Analytics.js: | The Segment Javascript library wrapper, which makes it simple to send your data to any tool without having to learn, test or implement the new API for each tool every time. API: | - Application Programming Interface. In software, this term describes a way of interacting with software in an automated fashion, without the use of a user-interface designed for humans. In Segment, we call the standard calls (`track`, `page` and `screen`, `identify` and `group`) our API. We also provide the [Config API](/docs/config-api/), which you can use to configure sources and destinations, and perform other functions in your workspace, without logging in using a web browser. + Application Programming Interface. In software, this term describes a way of interacting with software in an automated fashion, without the use of a user-interface designed for humans. In Segment, we call the standard calls (`track`, `page` and `screen`, `identify` and `group`) our API. We also provide the [Public API](/docs/api/), which you can use to configure sources and destinations, and perform other functions in your workspace, without logging in using a web browser. App: | The app is what we call the main Segment web application, the part you log in to, and where you configure sources and destinations, see events in the debugger, manage your tracking plan, and so on. diff --git a/src/_includes/menu/menu.html b/src/_includes/menu/menu.html index d847716a8d..e1aba550db 100644 --- a/src/_includes/menu/menu.html +++ b/src/_includes/menu/menu.html @@ -3,19 +3,6 @@
{% include menu/menu-primary.html %} - - -
  • diff --git a/src/connections/destinations/add-destination.md b/src/connections/destinations/add-destination.md index 118b0e4a18..779bc5ede5 100644 --- a/src/connections/destinations/add-destination.md +++ b/src/connections/destinations/add-destination.md @@ -12,7 +12,7 @@ Destinations are tools or services which can use the data sent from Segment to p ## Adding a destination -There are two ways to add a destination to your deployment: using the Segment web app, or using the [Config API](/docs/config-api/). +There are two ways to add a destination to your deployment: using the Segment web app, or using the [Public API](/docs/api/). #### Adding a destination from the Segment web app @@ -46,12 +46,12 @@ You can also add a destination directly from the source's settings page in the S 6. On the next page, find the **Connection Settings** section, and enter the token or credentials for that destination tool. 7. Click the toggle at the top of the Settings page to enable the destination. -#### Adding a destination using the Config API +#### Adding a destination using the Public API -You can use the Segment Config API to add destinations to your workspace using the [Create Destination endpoint](https://reference.segmentapis.com/#51d965d3-4a67-4542-ae2c-eb1fdddc3df6). The API requires an authorization token, and uses the `name` field as a namespace that defines which _source_ the destination is connected to. You send the rest of the destination's configuration as a JSON blob. View the documentation page in the Segment Catalog, or query the [Segment Catalog API](https://reference.segmentapis.com/#7a63ac88-43af-43db-a987-7ed7d677a8c8), for a destination to see the available settings. +You can use the Segment Public API to add destinations to your workspace using the [Create Destination endpoint](https://docs.segmentapis.com/tag/Destinations#operation/createDestination){:target = "_blank"}. The API requires an authorization token, and uses the `name` field as a namespace that defines which _source_ the destination is connected to. You send the rest of the destination's configuration as a JSON blob. View the documentation page in the Segment Catalog, or query the [Segment Catalog API](https://docs.segmentapis.com/tag/Catalog){:target="_blank"}, for a destination to see the available settings. > success "" -> You must use an authorization token to access the Config API, and these tokens are tied to specific workspaces. If you use the Config API to access multiple workspaces, make sure you're using the token for the workspace you want to access before proceeding. +> You must use an authorization token to access the Public API, and these tokens are tied to specific workspaces. If you use the Public API to access multiple workspaces, make sure you're using the token for the workspace you want to access before proceeding. ## What happens when you add a destination @@ -120,9 +120,9 @@ You can create unique destination filters for each destination instance connecte It is not possible to connect multiple instances of one source (for example, two website sources) to the same destination. However, you can create another instance of the destination for the other sources, and click **Copy Settings From Other Destination** to save yourself time entering the settings values again. -### Connect to more than one instance of a destination using the Config API +### Connect to more than one instance of a destination using the Public API -You can add multiple instances of a destination using the Segment Config API. See the Segment Config [API documentation](https://reference.segmentapis.com/?version=latest#39ce0439-0969-48c3-ba49-b22a46c41060). If a destination does not support multi-instance, the Config API throws an appropriate error. +You can add multiple instances of a destination using the Segment Public API. See the Segment Config [API documentation](https://docs.segmentapis.com/){:target="_blank"}. If a destination does not support multi-instance, the Public API throws an appropriate error. ### Multi-instance destinations and Device-mode diff --git a/src/connections/destinations/repeater-migration.md b/src/connections/destinations/repeater-migration.md index 6d16733fd5..b44099c774 100644 --- a/src/connections/destinations/repeater-migration.md +++ b/src/connections/destinations/repeater-migration.md @@ -46,9 +46,9 @@ You can create a QA instance of your destination to verify that it is configured 1. If you created a QA instance of the Repeater and you created a QA destination instance, you can test this process before you use production data. -2. You can disable the repeater and enable the new destination instance manually in the Segment web app, or by using the [Segment Config API](/docs/config-api/). +2. You can disable the repeater and enable the new destination instance manually in the Segment web app, or by using the [Segment Public API](/docs/-api/). - **If the destination can de-duplicate events**, enable the new instance of the destination, and _then_ disable the Repeater. - **If the destination does not de-duplicate events**, you can disable the Repeater and then enable the new instance of the destination. - This could result in minor data loss during the few seconds between the Repeater being disabled and the new destination instance being enabled. You can use the Segment Config API [Update Destination endpoint](https://reference.segmentapis.com/#f25d9ac1-3e20-4635-8687-26ed4153086d) to disable and enable destinations quickly, which can minimize the time between these two actions. However, we cannot guarantee that no data will be lost. + This could result in minor data loss during the few seconds between the Repeater being disabled and the new destination instance being enabled. You can use the Segment Public API [Update Destination endpoint](https://docs.segmentapis.com/tag/Destinations#operation/updateDestination){:target="_blank"} to disable and enable destinations quickly, which can minimize the time between these two actions. Segment does not guarantee that no data will be lost. If your workspace is on the Business Tier, and the destination supports [Replay](/docs/guides/what-is-replay/), you can replay the data from that period into the new destination instance. Replays are available for any destinations that support cloud-mode data (meaning data routed through Segment) and that also process timestamps. Contact your CSM for more information about replays. If the destination does not de-duplicate events and replays are not available, you can manually delete duplicate events in the destination. diff --git a/src/connections/functions/destination-functions.md b/src/connections/functions/destination-functions.md index 46b054579e..0437702d79 100644 --- a/src/connections/functions/destination-functions.md +++ b/src/connections/functions/destination-functions.md @@ -287,7 +287,7 @@ To test the batch handler: The editor displays logs and request traces from the batch handler. -The [Config API](/docs/config-api/) Functions/Preview endpoint also supports testing batch handlers. The payload must be a batch of events as a JSON array. +The [Public API](/docs/api/) Functions/Preview endpoint also supports testing batch handlers. The payload must be a batch of events as a JSON array. ### Handling batching errors diff --git a/src/connections/storage/catalog/aws-s3/index.md b/src/connections/storage/catalog/aws-s3/index.md index 9cf9026d91..fb34903a60 100644 --- a/src/connections/storage/catalog/aws-s3/index.md +++ b/src/connections/storage/catalog/aws-s3/index.md @@ -310,7 +310,7 @@ To finish configuration, enable the AWS S3 Destination with IAM Role Support des 6. Verify Segment data is stored in the S3 bucket by navigating to the `/segment-logs` in the AWS console. The bucket will take roughly 1 hour to begin receiving data. > info "" -> Did you know you can create destinations with the Config API? For more information, see [Create Destination](https://reference.segmentapis.com/#51d965d3-4a67-4542-ae2c-eb1fdddc3df6){:target="_blank"}. +> Did you know you can create destinations with the Public API? For more information, see [Create Destination](https://docs.segmentapis.com/tag/Destinations#operation/createDestination){:target="_blank"}. ## Migrate existing destinations diff --git a/src/connections/storage/warehouses/faq.md b/src/connections/storage/warehouses/faq.md index b6b167afd5..6466faf8e1 100644 --- a/src/connections/storage/warehouses/faq.md +++ b/src/connections/storage/warehouses/faq.md @@ -84,7 +84,7 @@ Amazon's service has some more powerful features and will be more cost-effective When you create a new source, the source syncs to all warehouse(s) in the workspace by default. You can prevent the source from syncing to some or all warehouses in the workspace in two ways: - **Segment app**: When you add a source from the Workspace Overview page, deselect the warehouse(s) you don't want the source to sync to as part of the "Add Source" process. All warehouses are automatically selected by default. -- **Config API**: Send a [PATCH Connected Warehouse request](https://reference.segmentapis.com/?version=latest#ec12dae0-1a3e-4bd0-bf1c-840f43537ee2) to update the settings for the warehouse(s) you want to prevent from syncing. +- **Public API**: Send a request to the [Update Warehouse](https://docs.segmentapis.com/tag/Warehouses#operation/updateWarehouse) endpoint to update the settings for the warehouse(s) you want to prevent from syncing. After a source is created, you can enable or disable a warehouse sync within the Warehouse Settings page. diff --git a/src/guides/usage-and-billing/account-management.md b/src/guides/usage-and-billing/account-management.md index 48cd3a4f3f..e60f49229b 100644 --- a/src/guides/usage-and-billing/account-management.md +++ b/src/guides/usage-and-billing/account-management.md @@ -28,7 +28,7 @@ You should also change your write keys for each source and remove all Segment sn ## What happens if I change my workspace name or slug? -Changing your workspace name or slug won't impact any sources or destinations you've already configured. If you're using [Segment's Config API](/docs/config-api/), though, you'll need to change the slug in your request URLs. +Changing your workspace name or slug won't impact any sources or destinations you've already configured. If you're using [Segment's Public API](/docs/api), you'll need to change the slug in your request URLs. ## Can I recover a source or workspace after I delete it? diff --git a/src/partners/checklist.md b/src/partners/checklist.md index 9ddedbf223..9c6bce219e 100644 --- a/src/partners/checklist.md +++ b/src/partners/checklist.md @@ -77,11 +77,10 @@ Once you've decided, you can: - Test component with the Dev Center Test Suite and get all green or yellow tests -We also highly encourage you to build a 1-click enablement of your tool with OAuth and the Segment Config API. Partners who have implemented "Enable with Segment" button in their sign-up flows have reported 2X increase in conversions. You can [refer to the docs for full details about building an Enable with Segment button](https://segment.com/docs/partners/enable-with-segment/). +Segment recommends you to build a 1-click enablement of your tool with OAuth and the Segment Public API. Partners who have implemented "Enable with Segment" button in their sign-up flows have reported 2X increase in conversions. You can [refer to the docs for full details about building an Enable with Segment button](https://segment.com/docs/partners/enable-with-segment/). - Implement one-click set up using Enable with Segment / OAuth -> Note: If you are time constrained, you may skip the above step for now. Once we see at-least 5 customers using your public beta integration, it's a hard requirement to build "Enable with Segment" button in your sign-up flows or app/settings page for general availability. By building this, we are making it super easy for future customers to turn ON your Integration. Not doing so, will result in de-listing your Integration from the Segment Catalog. ## 5. Partner Test diff --git a/src/partners/enable-with-segment.md b/src/partners/enable-with-segment.md index 7d00bab692..1efa44ac35 100644 --- a/src/partners/enable-with-segment.md +++ b/src/partners/enable-with-segment.md @@ -5,7 +5,7 @@ title: Enable with OAuth > info "" > If you're a customer who just wants to build a simple script or app against a single workspace, you may want to use [Workspace Access Tokens](/docs/config-api/authentication). -Enable with OAuth, supported with our [Config API](/docs/config-api), allows partners to build seamless flows for customers to implement and enable integrations within their workspace. This is a [post-launch requirement](/docs/partners/#post-launch) for a partner to graduate from public beta to public. +Enable with OAuth, supported with the [Public API](/docs/api), allows partners to build seamless flows for customers to implement and enable integrations within their workspace. This is a [post-launch requirement](/docs/partners/#post-launch) for a partner to graduate from public beta to public. ## Concepts @@ -13,7 +13,7 @@ Before getting started with your implementation, it's important to understand th ### Apps -As a partner developing an integration using Segment's Config API, everything starts from an **App**. An App behaves like a standard OAuth client, but adds granular permissions. When a user installs your App through the familiar OAuth flow, we require the user to grant access to a specific workspace and source. The user must also be a Workspace Owner of the authorized workspace. +As a partner developing an integration using Segment's Public API, everything starts from an **App**. An App behaves like a standard OAuth client, but adds granular permissions. When a user installs your App through the familiar OAuth flow, Segment requires the user to grant access to a specific workspace and source. The user must also be a Workspace Owner of the authorized workspace. As a destination partner, you may only manage your own destination on the workspace and source authorized by the user. @@ -21,7 +21,7 @@ As a destination partner, you may only manage your own destination on the worksp Segment Workspace Owners authorize your App on their workspace using a web-based authorization flow, exactly like OAuth. When authorized, Segment creates an **App Install** on the workspace. -Therefore, the token returned by Segment isn't tied to a user – it's tied to an App Install. That's why we call it an Install Token. +Therefore, the token returned by Segment isn't tied to a user – it's tied to an App Install. ## Set up Guide @@ -29,7 +29,7 @@ There are three steps to implement an "Enable with Segment" OAuth flow: 1. Create an App through Segment's Developer Center. 2. Set up an OAuth consumer that will participate in your Segment App's OAuth handshake. -3. Run your OAuth consumer, and verify that you can access resources – i.e. enable, configure, disable, and monitor your destination – on a user's behalf. +3. Run your OAuth consumer, and verify that you can access resources – for example, enable, configure, disable, and monitor your destination – on a user's behalf. ### 1. Create an App through Segment's Developer Center diff --git a/src/partners/spec.md b/src/partners/spec.md index ca1687d0c0..11da26511f 100644 --- a/src/partners/spec.md +++ b/src/partners/spec.md @@ -589,7 +589,7 @@ Docs coming soon. ## Delete -A Segment user can trigger delete action using [Config API](https://reference.segmentapis.com/?version=latest#57a69434-76cc-43cc-a547-98c319182247) or App. Partners are required to delete data for `userId` in the request payload in line with GDPR and CCPA. +Segment users can trigger the delete action withg [Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"} or App. Partners are required to delete data for `userId` in the request payload in line with GDPR and CCPA. This results in the following event data: diff --git a/src/privacy/user-deletion-and-suppression.md b/src/privacy/user-deletion-and-suppression.md index cf46212e8e..d33612a1c4 100644 --- a/src/privacy/user-deletion-and-suppression.md +++ b/src/privacy/user-deletion-and-suppression.md @@ -10,7 +10,7 @@ In keeping with Segment's commitment to GDPR and CCPA readiness, Segment offers > If you use this feature to delete data, you can not Replay the deleted data. For standard Replay requests, you must wait for any pending deletions to complete, and you cannot submit new deletion requests for the period of time that Segment replays data for you. > info "" -> The legacy GraphQL APIs for user deletion and suppression are deprecated. Instead, use the [Segment Config APIs](https://reference.segmentapis.com/?version=latest#57a69434-76cc-43cc-a547-98c319182247) to interact with the User Deletion and Suppression system. +> The legacy GraphQL APIs for user deletion and suppression are deprecated. Instead, use the [Segment Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"} to interact with the User Deletion and Suppression system. ## Overview @@ -52,7 +52,7 @@ You will also need to contact any unsupported Destinations separately to manage Note that if you later **UNSUPPRESS** a user, the deletion functionality does not clean up data sent after removing the user from the suppression list. -## Supressed users +## Suppressed users The Suppressed Users tab shows an up-to-date list of **actively** suppressed `userId`s. Segment blocks data about these users across all sources. @@ -74,27 +74,26 @@ The deletion requests tab shows a log of all regulations with a deletion element Click a deletion to view its status across Segment and your connected destinations. -> info "" -> Deletion requests submitted through one of Segment's APIs, either [Config API](https://reference.segmentapis.com/?version=latest#57a69434-76cc-43cc-a547-98c319182247){:target="_blank"} or [Public API](https://api.segmentapis.com/docs/connections/deletion-and-suppression/#create-workspace-regulation){:target="_blank"} (the Public API is currently in public beta, and will replace the Config API overtime), appear in this view. + ## Programmatic User Deletion and Suppression using the API -Use the [Segment Config APIs](https://reference.segmentapis.com/?version=latest#57a69434-76cc-43cc-a547-98c319182247){:target="_blank"} to interact with the User Deletion and Suppression system. +Use the [Segment Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"} to interact with the User Deletion and Suppression system. ### Regulate User from a single Source in a Workspace -Refer to [Create Source Regulation](https://reference.segmentapis.com/?version=latest#32732f1a-572c-457b-9c38-77f3c7f77559){:target="_blank"} in the Config API. +Refer to [Create Source Regulation](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/createSourceRegulation){:target="_blank"} in the Public API. ### Delete Object from a Cloud Source -Refer to the [Cloud Source Object Deletion](https://reference.segmentapis.com/?version=latest#1273ed6e-43e2-4cc2-a9bc-f0c7d2f153e8){:target="_blank"} Config API method. +Refer to the [Create Cloud Source Regulation](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/createCloudSourceRegulation){:target="_blank"} Public API endpoint. Cloud Sources sync objects to Segment. As a result, Cloud Sources are regulated based on an `objectId` instead of a `userId`. Before you delete the object from Segment, you should delete it from the upstream system first. ### List Suppressed Users for your Workspace -Refer to [List Suppressed Users](https://reference.segmentapis.com/?version=latest#2ad8f59e-2490-4a85-bc6d-d758a6a373ce){:target="_blank"} method in the Config API. +Refer to [List Suppressions](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/listSuppressions){:target="_blank"} method in the Public API. ### List Deletion Requests for your Workspace -Refer to the [List Regulations](https://reference.segmentapis.com/?version=latest#e27e4dac-892d-431e-b4f8-cee0eca5b3d8){:target="_blank"} Config API method. +Refer to the [List Regulations from Source](https://docs.segmentapis.com/tag/Deletion-and-Suppression#operation/listRegulationsFromSource){:target="_blank"} Public API method. diff --git a/src/protocols/apis-and-extensions/index.md b/src/protocols/apis-and-extensions/index.md index e65da868e0..c4310c32fd 100644 --- a/src/protocols/apis-and-extensions/index.md +++ b/src/protocols/apis-and-extensions/index.md @@ -12,11 +12,11 @@ With Protocols, you can help engineers reduce tracking errors, create issue noti If you're using Protocols, you might want to get notifications when event volume anomalies or Protocols violation counts occur. Read Segment's [anomaly detection documentation](/docs/protocols/apis-and-extensions/anomaly_detection/) to learn about common anomalies, as well as monitoring and alerting solutions you can implement using standard tools. -## Config API +## Public API -Protocols customers can access [Segment's Config API](/docs/config-api/), which enables programmatic creation, configuration, and fetching of core Segment platform resources like Sources, Destinations, and Tracking Plans. +Protocols customers can access [Segment's Public API](/docs/api/), which enables programmatic creation, configuration, and fetching of core Segment platform resources like Sources, Destinations, and Tracking Plans. -The Config API represents Segment's commitment to developers, helping you extend your workflow around customer data collection and activation. +The Public API represents Segment's commitment to developers, helping you extend your workflow around customer data collection and activation. ### Supported Operations diff --git a/src/protocols/apis-and-extensions/typewriter-v7.md b/src/protocols/apis-and-extensions/typewriter-v7.md index dd4beadb0d..d392cc99ae 100644 --- a/src/protocols/apis-and-extensions/typewriter-v7.md +++ b/src/protocols/apis-and-extensions/typewriter-v7.md @@ -114,13 +114,13 @@ $ npx typewriter@7 ## API Token Configuration -Typewriter requires a Segment API token to fetch Tracking Plans from the [Segment Config API](/docs/config-api/). +Typewriter requires a Segment API token to fetch Tracking Plans from the [Segment Public API](/docs/api/). You must be a workspace owner to create Segment API tokens. To create an API token: 1. Click on the **Tokens** tab on the [Access Management](https://app.segment.com/goto-my-workspace/settings/access-management){:target="_blank"} page and click **Create Token**. -2. Choose Segment's Config API. +2. Choose Segment's Public API. 3. Add a description for the token and assign access. If you choose *Workspace Member*, you only need to select **Tracking Plan Read-Only** for the Resource Role, as Typewriter only needs the *Tracking Plan Read-Only* role. 4. Click **Create**. diff --git a/src/protocols/apis-and-extensions/typewriter.md b/src/protocols/apis-and-extensions/typewriter.md index 2892db09a0..c1642ae24c 100644 --- a/src/protocols/apis-and-extensions/typewriter.md +++ b/src/protocols/apis-and-extensions/typewriter.md @@ -306,10 +306,8 @@ $ npx typewriter ## API Token Configuration -Typewriter requires a Segment API token to fetch Tracking Plans from the [Segment Public API](https://api.segmentapis.com/docs/). +Typewriter requires a Segment API token to fetch Tracking Plans from the [Segment Public API](https://docs.segmentapis.com/). -> info "" -> If you use a previous version of Typewriter that fetches tracking plans from the [Segment Config API](/docs/config-api/) and would like to upgrade to the new version of Typewriter, generate a new API token by following the steps below. You must be a workspace owner to create Segment API tokens. diff --git a/src/protocols/tracking-plan/create.md b/src/protocols/tracking-plan/create.md index e1af53ece9..4f16d686a9 100644 --- a/src/protocols/tracking-plan/create.md +++ b/src/protocols/tracking-plan/create.md @@ -144,7 +144,7 @@ To edit the common JSON schema: 3. Once you've saved and merged your JSON schema changes, go to the **Settings** tab for your source. 4. Click **Schema Configuration** in the navigation and go to the **Advanced Blocking Controls** section to define specific blocking behavior for common JSON schema violations. -To edit the common JSON schema using the Config API, you'll need to add your new JSON schema under the `"global"`: object. +To edit the common JSON schema using the Public API, you'll need to add your new JSON schema under the `"global"`: object. > info "" > [Negative lookahead regexes (`?!`)](https://www.regular-expressions.info/lookaround.html) aren't supported. This means you can't use regex to prevent matches with a specific following character or expression. But, you can use `not` in the regex of your JSON schema to generate violations when a property key or value doesn't match the provided regex pattern. diff --git a/src/segment-app/iam/concepts.md b/src/segment-app/iam/concepts.md index 893437eadf..fbedb11d9b 100644 --- a/src/segment-app/iam/concepts.md +++ b/src/segment-app/iam/concepts.md @@ -16,7 +16,7 @@ A *User Group* is a set of Team Members with a set of shared policies. A Segment ## Tokens -You can generate tokens to programmatically access Segment resources using the [Segment Config API](/docs/config-api/). +You can generate tokens to programmatically access Segment resources using the [Segment Public API](/docs/api/). ![](images/token-overview.png) From ca967ad0bb1e5a3f30d809e31602c5a0ba0f7bdd Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Fri, 2 Sep 2022 14:37:14 -0700 Subject: [PATCH 9/9] typo --- src/partners/spec.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/partners/spec.md b/src/partners/spec.md index 11da26511f..4f968b5386 100644 --- a/src/partners/spec.md +++ b/src/partners/spec.md @@ -589,7 +589,7 @@ Docs coming soon. ## Delete -Segment users can trigger the delete action withg [Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"} or App. Partners are required to delete data for `userId` in the request payload in line with GDPR and CCPA. +Segment users can trigger the delete action with the [Public API](https://docs.segmentapis.com/tag/Deletion-and-Suppression){:target="_blank"} or App. Partners are required to delete data for `userId` in the request payload in line with GDPR and CCPA. This results in the following event data: