Remove mentions of CSDK, replace with general Adobe IO authentication… #1
Conversation
| @@ -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.
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.
Yes, that's correct. It is a separate system.
There was a problem hiding this comment.
@jani9000 I'm not following. Are you saying that this revision is inaccurate? Or can it stand?
There was a problem hiding this comment.
@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)."
|
|
||
| ## 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 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.
"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.
@jani9000 Added the link, good call.
The guide mentions both auth steps in the previous paragraph (line 23):
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 explains how to do all of that — start at the “Register with us” section. Once you have done that stuff, return to this guide.
What if we retitled the heading above that paragraph like this?
Register, then add both auth mechanisms
partnership.md
Outdated
| ### Authenticate using the Creative SDK | ||
| If your integration aims to give users access to their Typekit accounts by signing in with an Adobe ID, you’ll also need to integrate an [authentication component from the Creative SDK](https://creativesdk.adobe.com/docs.html). To get access to the Creative SDK, use the [Console](http://adobe.io/console) to add it to your integration as a service along side Typekit. | ||
| ### Authenticate | ||
| If your integration aims to give users access to their Typekit accounts by signing in with an Adobe ID, you’ll also need to integrate an [authentication component](https://www.adobe.io/authentication.html). |
There was a problem hiding this comment.
The API can be useful for use cases where authentication is not necessary, but this is not explicitly mentioned anywhere. Can we add words, like: "Typekit Platform API offers functionality for both signed-out and signed-in clients. You can for example call the GET /variations/{id} API to get details about a font without having a signed in user. If you need to call an API that requires authentication (like GET /selections), you'll need to call the API with an Authentication header. In either case, you do need to pass in your Client ID.
… info
From Ivan Bettger:
Need someone knowledgeable about the implementation of the Adobe Fonts API to review and confirm that the copy changes I made are accurate.