Skip to content

Commit 684f7ab

Browse files
removing references to JWT, also renamed OAuth credentials to be OAuth user authentication credentials
1 parent f770aa8 commit 684f7ab

23 files changed

+247
-244
lines changed

gatsby-config.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,16 @@ module.exports = {
8080
title: "Services",
8181
pages: [
8282
{
83-
path: "guides/services/services-add-api-jwt.md",
84-
title: "Add API using Service Account (JWT)"
83+
path: "guides/services/services-add-api-oauth-s2s.md",
84+
title: "Add API using OAuth Server-to-Server credential"
8585
},
8686
{
8787
path: "guides/services/services-add-api-key.md",
88-
title: "Add API using API Key"
88+
title: "Add API using API Key credential"
8989
},
9090
{
9191
path: "guides/services/services-add-api-oauth.md",
92-
title: "Add API using Oauth"
92+
title: "Add API using OAuth User authentication credential"
9393
},
9494
{
9595
path: "guides/services/services-add-event.md",

src/pages/guides/services/index.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,14 @@ Access to some APIs is based on licenses. Meaning either the licenses your compa
2424

2525
APIs can be connected to your app in multiple ways, depending on the API or the type of app that you are building. Occasionally APIs will provide multiple connection options, allowing you to choose the type of connection that works best for your application. To learn more about each of these authentication methods or API connections, read the [authentication documentation](../authentication/index.md).
2626

27-
* [Add an API using Service Account (JWT) authentication](services-add-api-jwt.md)
28-
* [Add an API using OAuth authentication](services-add-api-oauth.md)
27+
* [Add an API using OAuth Server-to-Server credential](services-add-api-oauth-s2s.md)
28+
* [Add an API using OAuth User authentication credential](services-add-api-oauth-user-authentication.md)
2929
* [Add an API using API Key authentication](services-add-api-key.md)
3030

31+
<InlineAlert slots="text"/>
32+
33+
See our [authentication guide](../authentication/index.md) to learn about the available credential types.
34+
3135
### Add Event
3236

3337
Adobe I/O Events allow you to receive notifications of real-time events taking place in Adobe services. To add this service to your project you must register a webhook, to which Adobe I/O Events sends HTTP POST requests containing the details of each event. Using Events, you can build event-driven applications that integrate with Adobe. To learn more about Adobe I/O Events, read the [Events documentation](https://www.adobe.com/go/devs_events).
@@ -52,7 +56,7 @@ Occasionally you may need to remove a service once it has been added to your pro
5256

5357
Once you have successfully added APIs to your project or workspace, you can return to the **Project overview** (or **Workspace overview** in a templated project) at any time to view the details for that API and any other project services you may have added. You can select the specific API from the left navigation to view its details or remove the API using the **Remove API** button in the top-right corner.
5458

55-
You can also select the specific credential type from the left navigation to view the **Credential details** and perform other actions (generate JWT tokens, copy credential details, retrieve client secrets, etc.) as needed. For more information on accessing credentials, please read the [credentials overview](../credentials.md).
59+
You can also select the specific credential type from the left navigation to view the **Credential details** and perform other actions (generate access tokens, copy credential details, retrieve client secrets, etc.) as needed. For more information on accessing credentials, please read the [credentials overview](../credentials.md).
5660

5761
To view credentials for events, select the specific event registration from the left navigation and select the **Credentials** tab. For more information on working with events, including viewing event credentials, follow the guide for [adding Events to your project or workspace](services-add-event.md).
5862

Lines changed: 1 addition & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,5 @@
11
# Add API to project using Service Account (JWT)
22

3-
Adding an API to an empty project is the same whether you are working in a personal or enterprise project. Adding an API to a templated project is similar, with one small variation: APIs are added to individual workspaces, not to the project as a whole.
4-
5-
To begin adding an API from within a templated project, first select the appropriate workspace to open the *Workspace overview*. Then, select **+ Add Service** in the left navigation and choose **API** from the dropdown.
6-
7-
In an empty project, select **+Add to Project** in the left navigation of the *Project overview* and then choose **API**, or select **Add API** from the quick start buttons.
8-
9-
![](../../images/services-add-to-project.png)
10-
11-
## Add an API
12-
13-
Using REST APIs allows your application to make calls to Adobe services and products. The *Add an API* dialog shows a list of available services with the default *View by* setting to show only those services available to you.
14-
15-
<InlineAlert slots="text"/>
16-
17-
Many services are only available through paid licenses or subscriptions. Licenses and subscriptions can refer to either your organization or your personal licenses if you are building a personal project. For this reason, if you select "All" from the *View by* dropdown, you may notice that several services appear greyed out in the list. If you believe that you should have access to one of these disabled services, please speak with your system administrator or Adobe sales representative.
18-
19-
![](../../images/services-add-api.png)
20-
21-
Once you have found and chosen an API that you would like to add, select **Next** to begin configuring the API.
22-
23-
![](../../images/services-select-api-jwt.png)
24-
25-
## Configure API
26-
27-
A service account (JWT) integration lets your application call Adobe services on its own behalf, or on the behalf of an enterprise organization. For this type of integration, a JSON Web Token (JWT) must be created that includes your credentials. You will then begin each session by exchanging the JWT for an access token. For more information, please read the [JWT Authentication documentation](../authentication/JWT/index.md).
28-
29-
### Create a new service account (JWT) credential
30-
31-
There are two options for creating the necessary credentials:
32-
33-
1. **Generate a key pair:** Adobe Developer Console generates a public/private key pair for you. This private key is not stored within Console, but it is automatically downloaded to your device.
34-
35-
In order to proceed with generating a key pair, choose Option 1 and then select **Generate keypair**.
36-
37-
2. **Upload your public key:** Create your own public/private key pair through terminal and upload your public key. To learn more, see the documentation on [creating a private key and public certificate](../authentication/JWT/JWTCertificate.md).
38-
39-
To upload your own public key, drag and drop a file from your computer or use *Select a File* to choose the file that you would like to use. Then select **Next** to proceed.
40-
41-
![](../../images/services-api-jwt-create.png)
42-
43-
If you select Option 1 to **Generate a key pair**, immediately upon selecting the **Generate keypair** button, a file is downloaded to your computer containing your private key, as well as all of your app settings.
44-
45-
If you select Option 2, you will be required to drag and drop or select your public certificate from your computer.
46-
473
<InlineAlert slots="text"/>
484

49-
Adobe does not record your private key, therefore you must make sure to securely store it. This includes downloaded private key files from Console or files generated elsewhere.
50-
51-
The public key is now visible, including an option to download the key, upload another public key, or generate another key pair.
52-
53-
If the selected API configuration is complete, a **Save configured API** button appears in the bottom right corner of the dialog. Selecting **Save configured API** will complete the configuration for the API. You can now proceed to the [API overview](#api-overview) section later in this guide.
54-
55-
Otherwise, please proceed to the next section on [selecting product profiles](#select-product-profiles).
56-
57-
![](../../images/services-api-jwt-keypair.png)
58-
59-
## Select product profiles
60-
61-
If necessary, you will continue configuring the API by choosing from a list of available product profiles. Your integration's service account will gain access to granular features of the Adobe product based on the product profiles that you select.
62-
63-
As product profiles are selected, they appear in the left navigation under *Product Profiles*. Once you have selected at least one profile, the **Save configured API** button will become available.
64-
65-
Continue selecting all required product profiles and, once complete, select **Save configured API** to complete the configuration.
66-
67-
![](../../images/services-api-jwt-choose-profiles.png)
68-
69-
## API overview
70-
71-
With the API configured, you are redirected to the API overview, providing links to documentation, the ability to download files in order to experiment with the API using Postman, and a dialog allowing you to generate an access token by providing your private key.
72-
73-
You can also elect to remove the API on this screen using the **Remove API** button or, if the API includes product profiles, edit the profiles selected during configuration.
74-
75-
![](../../images/services-api-jwt-added.png)
76-
77-
## Quota usage
78-
79-
Select APIs specify a quota, or fixed allowance, for usage. Often this is tied to trial programs that provide free credentials in order to test out a service. These trials provide a quota that is generous enough to get you up and running. Quota may also be tied to a specific agreement, outlining the amount of quota available and timelines for its use.
80-
81-
For APIs that provide a quota, a *Quota usage* section will appear at the top of the API overview when the API is selected in the left navigation.
82-
83-
For more information on quota usage, please visit the [quota usage overview](../quota.md).
84-
85-
![](../../images/quota-usage.png)
86-
87-
## Generate token
88-
89-
To generate a token, copy and paste your private key into the *Private key* field and select **Generate token**.
90-
91-
![](../../images/services-api-jwt-generate-token.png)
92-
93-
If the private key is correct, an access token will appear along with the ability to **Copy** the token for use.
94-
95-
![](../../images/services-api-jwt-token.png)
96-
97-
## Credentials
98-
99-
Now that you have added an API, you can return to the *Project overview* (or *Workspace overview* in a templated project) at any time to view the details for that API and any other project services you may have added.
100-
101-
You can select the specific API from the left navigation to view its details or remove the API using the **Remove API** button in the top-right corner.
102-
103-
You can also select the specific credential type from under *Credentials* in the left navigation to view the *Credential details* and perform other actions (generate JWT tokens, copy credential details, retrieve client secrets, etc.) as needed. For more information on accessing credentials, please read the [credentials overview](../credentials.md).
104-
105-
## Insights
106-
107-
Adobe Developer Console automatically generates valuable insights related to API usage for each enterprise project (or individual workspace when working in a templated project), as well as for each personal project, including XD Plugins.
108-
109-
To learn more about insights, begin by reading the [insights overview](../insights.md).
110-
111-
## Next steps
112-
113-
With an API successfully added, you can follow the same workflow steps to add additional APIs, or return to the [services overview](../services/index.md) to select another type of service to add to your project.
114-
115-
If you have completed development on your project and are ready to submit your application for approval, please read the [project approval guide](../projects/approval.md) to get started.
5+
Service Account (JWT) credentials have been deprecated in favor of the OAuth Server-to-Server credentials. View our [migration guide](../ServerToServerAuthentication/migration.md) to know more. The new version of this guide that uses OAuth Server-to-Server credentials is now available here - [**Add API to project using OAuth Server-to-Server credentials**](../services/services-add-api-oauth-s2s.md).
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Add API to project using OAuth Server-to-Server credential
2+
3+
Adding an API to an empty project is the same whether you are working in a personal or enterprise project. Adding an API to a templated project is similar, with one small variation: APIs are added to individual workspaces, not to the project as a whole.
4+
5+
To begin adding an API from within a templated project, first select the appropriate workspace to open the *Workspace overview*. Then, select **+ Add Service** in the left navigation and choose **API** from the dropdown.
6+
7+
In an empty project, select **+Add to Project** in the left navigation of the *Project overview* and then choose **API**, or select **Add API** from the quick start buttons.
8+
9+
![](../../images/services-add-to-project.png)
10+
11+
## Add an API
12+
13+
Using REST APIs allows your application to make calls to Adobe services and products. The *Add an API* dialog shows a list of available services with the default *View by* setting to show only those services available to you.
14+
15+
<InlineAlert slots="text"/>
16+
17+
Many services are only available through paid licenses or subscriptions. Licenses and subscriptions can refer to either your organization or your personal licenses if you are building a personal project. For this reason, if you select "All" from the *View by* dropdown, you may notice that several services appear greyed out in the list. If you believe that you should have access to one of these disabled services, please speak with your system administrator or Adobe sales representative.
18+
19+
![](../../images/services-add-api.png)
20+
21+
Once you have found and chosen an API that you would like to add, select **Next** to begin configuring the API.
22+
23+
![](../../images/services-select-api-oauth-s2s.png)
24+
25+
## Configure API
26+
27+
An OAuth Server-to-Server integration lets your application call Adobe services on its own behalf, or on the behalf of an enterprise organization. Learn more on Server to Server authentication [here](../authentication/ServerToServerAuthentication/index.md).
28+
29+
For this type of integration, your application can create an access token can be created by making a simple API call to Adobe IMS (see [implementation guide](../authentication/ServerToServerAuthentication/implementation.md)).
30+
31+
32+
### Create a new OAuth Server-to-Server credential
33+
34+
![](../../images/services-api-oauth-s2s-create.png)
35+
36+
OAuth Server-to-server credentials allow you to assign a credential name to them. This name appears in the Admin Console > Users > API Credentials. Choose a name for easy identification.
37+
38+
## Select product profiles
39+
40+
If necessary, you will continue configuring the API by choosing from a list of available product profiles. Your integration's service account will gain access to granular features of the Adobe product based on the product profiles that you select.
41+
42+
As product profiles are selected, they appear in the left navigation under *Product Profiles*. Once you have selected at least one profile, the **Save configured API** button will become available.
43+
44+
Continue selecting all required product profiles and, once complete, select **Save configured API** to complete the configuration.
45+
46+
![](../../images/services-api-oauth-s2s-choose-profiles.png)
47+
48+
## API overview
49+
50+
With the API configured, you are redirected to the API overview, providing links to documentation, the ability to download files in order to experiment with the API using Postman, and a dialog allowing you to generate an access token by providing your private key.
51+
52+
You can also elect to remove the API on this screen using the **Remove API** button or, if the API includes product profiles, edit the profiles selected during configuration.
53+
54+
![](../../images/services-api-oauth-s2s-added.png)
55+
56+
You can click on generate access token button and it will lead you to the credential overview page. This page shows you all details about the credential you just created, including when this credential was last used to generate an access token. Furthermore it gives you an easy way to generate access tokens, view the cURL command you can use to generate access tokens programmatically, and view scopes per service.
57+
58+
![](../../images/services-api-oauth-s2s-generate-token.png)
59+
60+
61+
62+
## Quota usage
63+
64+
Select APIs specify a quota, or fixed allowance, for usage. Often this is tied to trial programs that provide free credentials in order to test out a service. These trials provide a quota that is generous enough to get you up and running. Quota may also be tied to a specific agreement, outlining the amount of quota available and timelines for its use.
65+
66+
For APIs that provide a quota, a *Quota usage* section will appear at the top of the API overview when the API is selected in the left navigation.
67+
68+
For more information on quota usage, please visit the [quota usage overview](../quota.md).
69+
70+
![](../../images/quota-usage.png)
71+
72+
## Generate token
73+
74+
To generate a token, click on the button "Generate access token"
75+
76+
![](../../images/services-api-oauth-s2s-generate-token-2.png)
77+
78+
You can also view the cURL command you could use to generate access tokens programmatically.
79+
80+
![](../../images/services-api-oauth-s2s-view-curl-command.png)
81+
82+
You can also view the scopes per service to generate an access token that only works for a subset of services in your project.
83+
84+
![](../../images/services-api-oauth-s2s-view-scopes.png)
85+
86+
## Credentials
87+
88+
Now that you have added an API, you can return to the *Project overview* (or *Workspace overview* in a templated project) at any time to view the details for that API and any other project services you may have added.
89+
90+
You can select the specific API from the left navigation to view its details or remove the API using the **Remove API** button in the top-right corner.
91+
92+
You can also select the specific credential type from under *Credentials* in the left navigation to view the *Credential details* and perform other actions (generate access tokens, copy credential details, retrieve client secrets, etc.) as needed. For more information on accessing credentials, please read the [credentials overview](../credentials.md).
93+
94+
## Insights
95+
96+
Adobe Developer Console automatically generates valuable insights related to API usage for each enterprise project (or individual workspace when working in a templated project), as well as for each personal project, including XD Plugins.
97+
98+
To learn more about insights, begin by reading the [insights overview](../insights.md).
99+
100+
## Next steps
101+
102+
With an API successfully added, you can follow the same workflow steps to add additional APIs, or return to the [services overview](../services/index.md) to select another type of service to add to your project.
103+
104+
If you have completed development on your project and are ready to submit your application for approval, please read the [project approval guide](../projects/approval.md) to get started.

0 commit comments

Comments
 (0)