Skip to content

Commit

Permalink
Merge pull request #2147 from spryker/feature/frw-5858/master-downloa…
Browse files Browse the repository at this point in the history
…d-api-spec-file

FRW-5858 Added description how to API specification file download in data exchange API.
  • Loading branch information
lenadoc authored Oct 11, 2023
2 parents 58b66ea + 188effc commit d6c83f2
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,24 @@ If you don't see the needed table, it may be [excluded from configuring](/docs/s
7. Click **Save**.
This opens the **Data Exchange API Configuration** page with the endpoint displayed in the list. Now you can send requests to this endpoint.

{% info_block warningBox "Verification" %}

If everything is set up correctly, you can follow [How to send request in Data Exchange API](/docs/scos/dev/glue-api-guides/{{page.version}}/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.html) to discover how to request your API endpoint.
Or if you're in the middle of the integration process for the Data Exchange API follow [Data Exchange API integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/glue-api/data-exchange-api-integration.html) to proceed with it.

{% endinfo_block %}

## Download Data Exchange API specification

You can download the specification of all the available endpoints, including the Data Exchange API endpoints, in the OpenAPI format.
To download the specification, go to the *Data Exchange API Configuration* page, click **Download API Specification**. This initiates the download of the specification to your computer.

![deapi_download_spec_button](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/configure-data-exchange-api/deapi_download_spec_button.png)

In case you've added new endpoints, the documentation will be automatically updated with the new information after a minute. The **Download API Specification** button is inactive during the documentation update process and becomes available again after one minute. There is a notification about this at the top of the page:

![deapi_generation_in_progress](https://spryker.s3.eu-central-1.amazonaws.com/docs/pbc/all/data-exchange/configure-data-exchange-api/deapi_generation_in_progress.png)

## Next steps

[How to send request in Data Exchange API](/docs/scos/dev/glue-api-guides/{{page.version}}/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.html)
[Send request in Data Exchange API](/docs/scos/dev/glue-api-guides/{{page.version}}/data-exchange-api/how-to-guides/how-to-send-request-in-data-exchange-api.html)

0 comments on commit d6c83f2

Please sign in to comment.