Skip to content
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

Remove mentions of CSDK, replace with general Adobe IO authentication… #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-reference/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The Platform API supports both signed out and authenticated modes. When users are in the signed-out state, only the API key is required. You can authenticate as a user by sending a 'X-Typekit-Token' HTTP header.
janileppanen marked this conversation as resolved.
Show resolved Hide resolved

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://creativesdk.adobe.com/docs/web/#/articles/userauthui/index.html) from the Creative SDK. 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.
If your integration aims to give users access to their Typekit accounts by signing in with an Adobe ID, you’ll need to [use OAuth 2.0 to generate an access token](https://www.adobe.io/authentication/auth-methods.html#!adobeio/adobeio-documentation/master/auth/OAuth2.0Endpoints/web-oauth2.0-guide.md) for the user.
2 changes: 1 addition & 1 deletion api-reference/web_font_preview_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's correct. It is a separate system.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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?

Copy link
Contributor

Choose a reason for hiding this comment

The 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

Expand Down
6 changes: 3 additions & 3 deletions guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Publish/export workflow:

![Sketch showing publish export workflow](/img/publish-export-02.png)

## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The 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:

https://www.adobe.io/authentication/auth-methods.html#!adobeio/adobeio-documentation/master/auth/OAuth2.0Endpoints/web-oauth2.0-guide.md.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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):

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


Expand Down
11 changes: 3 additions & 8 deletions partnership.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
# Starting a new integration with Typekit

Welcome to our partner network. We love spreading the power of great typography, and look forward to hearing about what you’re working on. Here’s how to get started.

## Choose between Typekit and the Creative SDK
The Typekit Platform described here gives you direct access to Typekit APIs, allowing you to build any sort of Typekit integration you can imagine on web, mobile, or desktop – really, anywhere you can use RESTful APIs. If you’re looking for something a bit more plug and play, we also offer Typekit components in Adobe’s [Creative SDK](https://creativesdk.adobe.com/docs.html) for iOS and Android, allowing you to integrate common Typekit functionalities delivered through ready-to-go UI components with consistent design.

To work directly with Typekit Platform, read on for details on how to register with us. To use the Typekit components in the Creative SDK, visit the [Creative SDK documentation](https://creativesdk.adobe.com/docs.html).
Welcome to our partner network. We love spreading the power of great typography, and look forward to hearing about what you’re working on. The Typekit Platform described here gives you direct access to Typekit APIs, allowing you to build any sort of Typekit integration you can imagine on web, mobile, or desktop – really, anywhere you can use RESTful APIs. Read on for details on how to register with us.

## Register with us
### Use the Console to create an integration
If you want to jump right in, create an integration through the [Console](http://adobe.io/console) and add Typekit as a service. You’ll automatically get a developer key that you can use to start making [API requests](http://docs.typekit.io/) in development mode immediately. While in development mode, your integration can only be used in conjunction with 25 unique Adobe IDs and up to 1,000 pageviews per day of web font previews using our [Preview API](/api-reference/web_font_preview_api.md), but you’ll be able to remove these limits before you launch your integration by following our [approval process](/partnership/approval_process.md).

### 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/auth-methods.html#!adobeio/adobeio-documentation/master/auth/OAuth2.0Endpoints/web-oauth2.0-guide.md). Note that functionality exists for both signed-out and signed-in clients. For example, you can call `GET /variations/{id}` 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.

### Request a web font Preview API token
If you need to preview Typekit web fonts in your integration, you'll also need a token for Typekit's web font Preview API. To request your Preview API token, head over to the [Console](http://adobe.io/console) where, in an integration’s Services tab, you'll find a token generator in the “Configure Typekit Platform” area.
Expand Down
2 changes: 1 addition & 1 deletion partnership/approval_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Mostly for the sake of good performance, you should confirm that the number of f
We recommend that families used for body text always include regular, bold, and italic variations so that common in-line styling commands will work.

## Authenticate users before they select fonts
When account-level changes are possible through your integration, our Platform will require that users are signed in and authenticated in some way. This includes activities like syncing fonts for use in documents, and publishing kits for use on the web. (Note: authentication may not be required for some situations where the fonts are less exposed — such as browsing available fonts from Typekit without applying them to a document.) To authenticate users, you’ll 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 along side Typekit.
When account-level changes are possible through your integration, our Platform will require that users are signed in and authenticated in some way. This includes activities like syncing fonts for use in documents, and publishing kits for use on the web. (Note: authentication may not be required for some situations where the fonts are less exposed — such as browsing available fonts from Typekit without applying them to a document.) To authenticate users, you’ll need to integrate an [authentication component](https://www.adobe.io/authentication.html).

## Plan for fonts that become unavailable
Your app must always respect a user’s current Typekit font entitlement, which can change over time. When a user is no longer entitled to a Typekit font, or the font is removed or otherwise unavailable from Typekit, it will be evident when the user’s entitlement is validated, and your application must immediately remove it and otherwise make it unavailable.
Expand Down
6 changes: 3 additions & 3 deletions partnership/legal.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ The Platform allows apps to load fonts for authoring purposes under specific cir
Full sync fonts for document and media authoring purposes can only be downloaded:

* for an authenticated and entitled user, and
* by the Adobe Creative Cloud desktop app and the Adobe Creative SDK.
* by the Adobe Creative Cloud desktop app.

This means if your app seeks to add Typekit sync fonts to a user’s system fonts (on Mac or Windows) or directly to a Creative SDK-integrated app (on iOS or Android), you should:
This means if your app seeks to add Typekit sync fonts to a user’s system fonts (on Mac or Windows), you should:

* add them to the user’s Typekit “sync selection” via the /selections endpoint, and then
* rely on the Creative Cloud desktop app or the Typekit component of the Creative SDK to actually sync the fonts to the user’s device(s).
* rely on the Creative Cloud desktop app to actually sync the fonts to the user’s device(s).

At that point, the user may use the fonts as they would any other Typekit fonts synced to their device(s) by any other apps/service. See our [help page on font licensing](https://helpx.adobe.com/typekit/using/font-licensing.html) for a review of how end users may use sync fonts.

Expand Down