-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b915fcd
commit 0c4746f
Showing
9 changed files
with
8,506 additions
and
7,752 deletions.
There are no files selected for viewing
This file contains 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 |
---|---|---|
@@ -1,6 +1,35 @@ | ||
# FDK API-Spec | ||
|
||
You can find FDK API Specs | ||
Welcome to the FDK API Specifications repository. Here you will find resources to help you interact with the FDK API. | ||
|
||
* [Postman Collections v2.1](postman/) | ||
* [OpenAPI Specification v3.0](openapi/) | ||
## Available Resources | ||
|
||
* **Postman Collection (v2.1):** | ||
Access the full FDK API in an easy-to-use format for Postman. This collection allows you to quickly test and explore the API endpoints. | ||
[Download Postman Collection](postman/) | ||
|
||
* **OpenAPI Specification (v3.0):** | ||
The OpenAPI Specification provides a detailed, structured description of the FDK API, including available endpoints, request/response formats, and more. | ||
[Download OpenAPI Specification](openapi/) | ||
|
||
* **API Documentation:** | ||
Explore and play around with the FDK API directly from our interactive documentation. The documentation allows you to test API requests, review available endpoints, and understand the data flow. | ||
[View API Documentation](https://partners.fynd.com/help) | ||
|
||
## How to Use | ||
|
||
1. **Postman Collection:** | ||
- Import the JSON file into Postman to start testing the API. | ||
- Make sure to configure any necessary authentication tokens or environment variables. | ||
|
||
2. **OpenAPI Specification:** | ||
- Use the OpenAPI JSON with tools like Swagger UI or API management platforms to generate API clients or documentation automatically. | ||
- Alternatively, you can review the specification to understand how to interact with the API programmatically. | ||
|
||
3. **API Documentation:** | ||
- Visit our [API Documentation](https://partners.fynd.com/help) to test the endpoints in a browser-based environment. | ||
- Use interactive tools to experiment with different API requests and responses. | ||
|
||
--- | ||
|
||
We hope these resources help you effectively use the FDK API. If you have any questions or run into issues, feel free to raise them in the repository. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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
Oops, something went wrong.