-
Notifications
You must be signed in to change notification settings - Fork 116
Add invoke API docs #1162
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
Draft
shaniR
wants to merge
5
commits into
wso2:dev
Choose a base branch
from
shaniR:keys
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Add invoke API docs #1162
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
You can invoke the API using the access token you generated above. Use the following cURL command template, fill in the required fields, and invoke the API. | ||
|
||
=== "Format" | ||
``` curl | ||
curl -H "Authorization: Bearer <access_token>" <API_invocation_URL> | ||
``` | ||
|
||
=== "Example" | ||
``` curl | ||
curl -H "Authorization: Bearer eyJ4NXQiOiJaR1F6WXpaaE5XVTJZbVE1T0RBM....TueTTZ1qTwLgUL2Sivkjg" https://<instance_id>-dev.e1-us-east-azure.choreoapis.dev/xaxz/reading-list-service/readinglist-a57/1.0.0/books | ||
``` |
26 changes: 26 additions & 0 deletions
26
en/docs/consuming-services/generate-an-access-token-body.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
### Generate an access token in cURL | ||
|
||
You can follow the steps below to generate an access token for your application via cURL: | ||
|
||
1. In the [Choreo Developer Portal](https://devportal.choreo.dev) header, click **Applications**. | ||
2. On the **My Applications** page, click on the application for which you want to generate the token. | ||
3. In the left navigation menu, click the required environment under **Credentials**. This opens the **Application Keys** pane of the specific environment. | ||
4. Copy the **Consumer Key**, **Consumer Secret**, and **Token Endpoint** values. | ||
5. Use the following template and compile the cURL command with the values you copied in the above step. | ||
|
||
=== "Format" | ||
``` | ||
curl -k -X POST <token_endpoint> -d "grant_type=client_credentials" -H "Authorization: Basic <base64encode(consumer-key:consumer-secret)>" | ||
``` | ||
6. Execute the cURL command to generate an access token. | ||
|
||
|
||
### Generate an access token in the Choreo Console (for testing purposes) | ||
|
||
You follow the steps below to generate an access token for **testing purposes**: | ||
|
||
1. In the [Choreo Developer Portal](https://devportal.choreo.dev) header, click **Applications**. | ||
2. On the **My Applications** page, click on the application for which you want to generate keys and tokens. | ||
3. In the left navigation menu, click the required environment under **Credentials**. This opens the **Application Keys** pane of the specific environment. | ||
5. Click **Generate Token**. | ||
|
Empty file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Invoke an API | ||
|
||
Choreo Service components, whether they function through REST, gRPC, Ballerina Service, TCP, UDP, or other protocols, can be exposed as APIs. In the Choreo ecosystem, API security is implemented through OAuth 2.0. Consequently, when making calls to an API, the invocation must include an OAuth 2.0 bearer token in the HTTP header of the request. This token serves as a means of authentication, ensuring secure access to the API. Known as the API Access Token or Key, this string is an essential component that must accompany the API | ||
|
||
This guide will walk you through the steps you need to follow to invoke an API in Choreo either via a cURL command or via your web application. | ||
|
||
## Invoke an API via cURL | ||
|
||
{% include "consume-an-api-via-curl.md" %} | ||
|
||
## Invoke and API via a web application | ||
|
||
You can consume an API via your web application. Refer the steps in the guide [Consume a Service - Consume an API via a web application ](hhttps://wso2.com/choreo/docs//choreo/docs/consuming-services/consume-a-service/#consume-an-api-via-a-web-application) to learn how you can consume the API via your web application. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we just say the following to avoid repeating the term guide:
"This is an end-to-end guide that walks you through the following steps:"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done