-
Notifications
You must be signed in to change notification settings - Fork 7
Remove mentions of CSDK, replace with general Adobe IO authentication… #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ The solution we’ve created is to use a separate JavaScript API to load the ind | |
|
||
The Web Font Preview API is intended only to load web fonts for preview purposes – when, for example, end users of a Typekit integration are browsing available fonts or trying out various fonts on some web content they are about to publish. The Web Font Preview API should never be used to load Typekit fonts for published websites; a published kit must be used there instead. See our [guidelines for permitted use](/partnership/legal.md) for more details. | ||
|
||
Using the API requires authentication via an auth_id and auth_token. To get these, register with us by using the Adobe I/O [Console](http://adobe.io/console) to create an integration. Then add an [authentication component](https://creativesdk.adobe.com/docs.html) from the Creative SDK, and return to the [Console](http://adobe.io/console) to request a Web Font Preview API token (in an integration’s Services tab, you'll find a token generator in the “Configure Typekit Platform” area). We’ll set you up in development mode initially, limiting you to 1,000 pageviews per day of web font previews. You’ll be able to remove this limit before you launch your integration by following our [approval process](/partnership/approval_process.md). | ||
Using the API requires authentication via an auth_id and auth_token. To get these, register with us by using the Adobe I/O [Console](http://adobe.io/console) to create an integration. Then add an [authentication component](https://www.adobe.io/authentication.html) and return to the [Console](http://adobe.io/console) to request a Web Font Preview API token (in an integration’s Services tab, you'll find a token generator in the “Configure Typekit Platform” area). We’ll set you up in development mode initially, limiting you to 1,000 pageviews per day of web font previews. You’ll be able to remove this limit before you launch your integration by following our [approval process](/partnership/approval_process.md). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. AFAIK, there's nothing in https://www.adobe.io/authentication.html for web fonts preview API. It uses a completely different auth mechanism. @bramstein or @pzula should confirm. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, that's correct. It is a separate system. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jani9000 I'm not following. Are you saying that this revision is inaccurate? Or can it stand? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @tbrown You should remove the part about adding an authentication component (it's not needed for web fonts preview API): "Using the API requires authentication via an auth_id and auth_token. To get these, register with us by using the Adobe I/O Console to create an integration. Then add an authentication component and return to the Console to request a Web Font Preview API token (in an integration’s Services tab, you'll find a token generator in the “Configure Typekit Platform” area)." ...should be: "Using the API requires authentication via an auth_id and auth_token. To get these, register with us by using the Adobe I/O Console to create an integration and to request a Web Font Preview API token (in an integration’s Services tab, you'll find a token generator in the “Configure Typekit Platform” area)." |
||
|
||
## Using the API | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,13 +18,13 @@ Publish/export workflow: | |
|
||
 | ||
|
||
## Register with Typekit Platform | ||
## Register, then add both auth mechanisms | ||
|
||
The first thing to do is register with us by using the Adobe I/O console to create an integration. Then add an authentication component from the Creative SDK, and request a Web Font Preview API token. [This page](partnership.md) explains how to do all of that — start at the “Register with us” section. Once you have done that stuff, return to this guide. | ||
The first thing to do is register with us by using the Adobe I/O console to create an integration. Then add an authentication component and request a Web Font Preview API token. [This page](partnership.md) explains how to do all of that — start at the “Register with us” section. Once you have done that stuff, return to this guide. | ||
|
||
## Introduce your users to Typekit | ||
|
||
As part of your application’s typography tools (for picking a font, choosing a size, etc.), offer an action to add more fonts from Typekit. Tell people what Typekit is (a service for finding, getting, and using fonts), and that they will need to sign in with their Adobe ID to access Typekit fonts. Prompt them to sign in (or get an Adobe ID) using the [User Auth UI](https://creativesdk.adobe.com/docs/web/#/articles/userauthui/index.html) component of Adobe’s Creative SDK. | ||
As part of your application’s typography tools (for picking a font, choosing a size, etc.), offer an action to add more fonts from Typekit. Tell people what Typekit is (a service for finding, getting, and using fonts), and that they will need to [sign in with their Adobe ID](https://www.adobe.io/authentication/auth-methods.html#!adobeio/adobeio-documentation/master/auth/OAuth2.0Endpoints/web-oauth2.0-guide.md) to access Typekit fonts. Prompt them to sign in (or get an Adobe ID). | ||
|
||
You’re going to need to have this auth token for much of what you want to do in an integration. So keep it handy. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "This auth token" is a little ambiguous. "Sign in with their Adobe ID" should link to the OAuth 2.0 guide: Maybe this doc should have an explicit section about the two different auth mechanisms used for web based integrations — one for loading preview fonts using Web Fonts Preview API, and another to call Typekit Platform API endpoints as a logged in user. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jani9000 Added the link, good call. The guide mentions both auth steps in the previous paragraph (line 23):
What if we retitled the heading above that paragraph like this?
|
||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.