Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Magento 2 Developer's Guide v1.0.0.0 for Imagine #45

Merged
1 commit merged into from
May 11, 2014
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ You have the following options to create your integration:

* Creating the integration using the Magento Admin, which you might prefer if you aren't comfortable creating configuration files. For more information, see Manually Creating an Integration Using the Magento Admin.

* Automatically creating the integration by providing it as an extension package. For more information, see [Creating an Integration Automatically]({{ site.baseurl }}/guides/m2devgde/v1.0.0.0/integration/integration-create-man.html)).
* Automatically creating the integration by providing it as an extension package. For more information, see [Creating an Integration Automatically]({{ site.baseurl }}guides/m2devgde/v1.0.0.0/integration/integration-create-man.html)).

8 changes: 4 additions & 4 deletions guides/m2devgde/v1.0.0.0/rest/rest-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ In this case, the return object is Customer.php.

#### Related Topics:

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
10 changes: 5 additions & 5 deletions guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Before interacting with a service, you must be familiar with the service interfa

To directly invoke a service using its PHP interface, use dependency injection. To do this, simply define a constructor dependency on the service you need. From there, you can use the instance to directly invoke methods on the interface.

Because a service call typically accepts one or more primitive types (or [service data objects]({{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html#about-service-data-objects)), you might have to convert or extract before calling the service. For an example, see `public function getInputData` in <a href="https://github.com/magento/magento2/blob/master/app/code/Magento/Webapi/Controller/ServiceArgsSerializer.php" target="_blank">this Web API class</a>.
Because a service call typically accepts one or more primitive types (or [service data objects]({{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html#about-service-data-objects)), you might have to convert or extract before calling the service. For an example, see `public function getInputData` in <a href="https://github.com/magento/magento2/blob/master/app/code/Magento/Webapi/Controller/ServiceArgsSerializer.php" target="_blank">this Web API class</a>.

For example, if you know a customer's ID and want to get data about the customer, here's what you do:

Expand All @@ -33,7 +33,7 @@ Service methods complete in one of two ways:

Primitive type (such as an ID)

[Service data object]({{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html#about-service-data-objects). A service data object holds only primitives or other service data objects and so on. In this case, it is up to the client to use the data returned in whatever way is appropriate.
[Service data object]({{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html#about-service-data-objects). A service data object holds only primitives or other service data objects and so on. In this case, it is up to the client to use the data returned in whatever way is appropriate.

* Throw an exception

Expand All @@ -43,10 +43,10 @@ Service methods complete in one of two ways:

Any service that has an `app/code/[Vendor]/[Module]/etc/webapi.xml` can be accessed using REST and SOAP. (Additional tasks, not discussed here, are required to access services using SOAP.)

To set up a service so it can be accessed using REST, see [What is the Web API Framework?]({{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html)
To set up a service so it can be accessed using REST, see [What is the Web API Framework?]({{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html)

#### Related Topics:

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>
8 changes: 4 additions & 4 deletions guides/m2devgde/v1.0.0.0/svcs-framework/svc-method-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ Services are _not_ responsible for:

#### Related Topics:

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
8 changes: 4 additions & 4 deletions guides/m2devgde/v1.0.0.0/svcs-framework/svcs-props.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ Services are _not_ responsible for:

#### Related Topics:

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
6 changes: 3 additions & 3 deletions guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Using services interfaces, an integrator can more easily interact with Magento 2

#### Related Topics:

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/svcs-props.html">Understanding the Properties and Responsibilities of a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svcs-props.html">Understanding the Properties and Responsibilities of a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
8 changes: 4 additions & 4 deletions guides/m2devgde/v1.0.0.0/webapi/webapi-basic-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ title: Authorizing Web API Requests

This topic provides basic information about how to authorize Web API requests.

When a merchant installs an integration, they must be informed which Magento resources the Magento integration needs access to. To see how a merchant authorizes an integration, go to [What is the Web API Framework?]({{ site.baseurl }}/guides/m2devgde/v1.0.0.0/integration/integration-auth.html)).
When a merchant installs an integration, they must be informed which Magento resources the Magento integration needs access to. To see how a merchant authorizes an integration, go to [What is the Web API Framework?]({{ site.baseurl }}guides/m2devgde/v1.0.0.0/integration/integration-auth.html)).

Service developers declare the list of permissions required in the integration's `webapi.xml`. This is discussed in more detail in [What is the Web API Framework?]({{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html)).
Service developers declare the list of permissions required in the integration's `webapi.xml`. This is discussed in more detail in [What is the Web API Framework?]({{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html)).

**Note**: The Web API framework only verifies that the user (Magento administrator, anonymous user, API user, and so on) is authorized to invoke the API. Any business logic specific authorizations must be implemented at the service level.

Expand Down Expand Up @@ -59,6 +59,6 @@ For the call to succeed, _all_ resources must be authorized; otherwise, an autho

#### Related Topics:

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/build-svc.html">Basics of Building a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.html">What Is the Web API Framework?</a>
10 changes: 5 additions & 5 deletions guides/m2devgde/v1.0.0.0/webapi/what-is-webapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ Your module can use `webapi.xsd` or you can create a customized validation.

#### Related Topics:

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/webapi/webapi-basic-auth.html">Authorizing Web API Requests</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/webapi/webapi-basic-auth.html">Authorizing Web API Requests</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/what-is-svc.html">What is the Magento 2 Service Framework?</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/rest/rest-overview.html">Accessing Magento Objects Using REST</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/rest/rest-overview.html">Accessing Magento Objects Using REST</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svc-how-to-use.html">How a Client Uses a Service</a>

* <a href="{{ site.baseurl }}/guides/m2devgde/v1.0.0.0/svcs-framework/svcs-props.html">Understanding the Properties and Responsibilities of a Service</a>
* <a href="{{ site.baseurl }}guides/m2devgde/v1.0.0.0/svcs-framework/svcs-props.html">Understanding the Properties and Responsibilities of a Service</a>