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.

Sign up for GitHub

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

Jump to bottom

Updating getting started #294

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Updating getting started #294

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5df151c
Updating getting started
jhadobe Mar 12, 2024
c84135b
quick edit and linter wants hyphens
jhadobe Mar 12, 2024
406b8ce
Merge branch 'main' into jh_get_started
jhadobe Jun 5, 2024
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
41 changes: 23 additions & 18 deletions src/pages/get-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,42 +8,47 @@ keywords:

# Getting started with Adobe Commerce web APIs

The Adobe Commerce and Magento Open Source web API framework provides integrators and developers the means to use web services that communicate with the application. Key features include:
The Adobe Commerce and Magento Open Source web API framework provides integrators and developers the means to use web services that communicate with the application.

* Support for [GraphQL](../graphql/), [REST](https://developer.adobe.com/commerce/webapi/rest/) (Representational State Transfer) and [SOAP](soap-web-api-calls.md) (Simple Object Access Protocol).
- Learn more about [GraphQL](../graphql/index.md)
- Learn more about [REST](../rest/index.md)

* Three types of [authentication](./authentication/index.md):
* Third-party applications authenticate with [OAuth 1.0a](./authentication/gs-authentication-oauth.md).
* Mobile applications authenticate using [tokens](./authentication/gs-authentication-token.md).
* Administrators and customers are authenticated with [login credentials](./authentication/gs-authentication-token.md).
## What can I do with the web APIs?

* All accounts and integrations are assigned resources that they have access to. The API framework checks that any call has the authorization to perform the request.
The APIs can be used to perform a wide array of tasks. For example:

* Any native or third-party service can be [configured as a web API](https://developer.adobe.com/commerce/php/development/components/web-api/services/) with a few lines of xml. To configure a web API, you define XML elements and attributes in a `webapi.xml` configuration file. If a service is not defined in a configuration file, it will not be exposed at all.
- Create a shopping app. This can be a traditional app that a user downloads on a mobile device. You could also create an app that an employee uses on a showroom floor to help customers make purchases.

* The framework is based on the CRUD (create, read, update, delete) & search model. The system does not currently support webhooks.
- Integrate with CRM (Customer Relationship Management) or ERP (Enterprise Resource Planning) backend systems, such as Salesforce or Xero.

* The framework supports field filtering of web API responses to conserve mobile bandwidth.
- Integrate with a CMS (Content Management System). Currently, content tagging is not supported.

* Integration style web APIs enable a single web API call to run multiple services at once for a more efficient integration. An example of this behavior can be seen in the Catalog where one web API call can create a product. If your payload includes the `stock_item` and `media_gallery_entries` objects, then the framework will also create the product's inventory & media in that one API call.
- Create JavaScript widgets in the storefront or on the Admin panel. The widget makes AJAX calls to access services.

## What can I do with the web APIs?
## Key features

The APIs can be used to perform a wide array of tasks. For example:
- Support for [GraphQL](../graphql/), [REST](https://developer.adobe.com/commerce/webapi/rest/) (Representational State Transfer) and [SOAP](soap-web-api-calls.md) (Simple Object Access Protocol).

- Three types of [authentication](./authentication/index.md):
- Third-party applications authenticate with [OAuth 1.0a](./authentication/gs-authentication-oauth.md).
- Mobile applications authenticate using [tokens](./authentication/gs-authentication-token.md).
- Administrators and customers are authenticated with [login credentials](./authentication/gs-authentication-token.md).

- All accounts and integrations are assigned resources that they have access to. The API framework checks that any call has the authorization to perform the request.

* Create a shopping app. This can be a traditional app that a user downloads on a mobile device. You could also create an app that an employee uses on a showroom floor to help customers make purchases.
- Any native or third-party service can be [configured as a web API](https://developer.adobe.com/commerce/php/development/components/web-api/services/) with a few lines of XML. To configure a web API, you define XML elements and attributes in a `webapi.xml` configuration file. If a service is not defined in a configuration file, it will not be exposed at all.

* Integrate with CRM (Customer Relationship Management) or ERP (Enterprise Resource Planning) backend systems, such as Salesforce or Xero.
- The framework is based on the CRUD (create, read, update, delete) & search model. The system does not currently support webhooks.

* Integrate with a CMS (Content Management System). Currently, content tagging is not supported.
- The framework supports field filtering of web API responses to conserve mobile bandwidth.

* Create JavaScript widgets in the storefront or on the Admin panel. The widget makes AJAX calls to access services.
- Integration-style web APIs enable a single web API call to run multiple services at once for more efficient integrations. An example of this behavior can be seen in the Catalog where one web API call can create a product. If your payload includes the `stock_item` and `media_gallery_entries` objects, then the framework will also create the product's inventory & media in that one API call.

## How do I get started?

You must register a web service on Admin. Use the following general steps to set up Magento to enable web services.

1. If you are using token-based authentication, create a web services user on Admin by selecting **System** > Permission > **All Users** > Add New User. (If you are using session-based or OAuth authentication, you do not need to create the new user in the Admin.)
1. If you are using token-based authentication, create a web services user on Admin by selecting **System** > Permission > **All Users** > Add New User. (If you are using session-based or OAuth authentication, you do not need to create a new user in the Admin.)
1. Create a new integration on Admin. To create an integration, click **System** > Extensions > **Integration** > Add New Integration**. Be sure to restrict which resources the integration can access.
1. Use a REST or SOAP client to configure authentication.

Expand Down
Loading