Welcome to the Four Way Shop REST API documentation. Our suite offers two distinct services, each providing a set of APIs tailored to specific functionalities within the application. This introductory guide will help you understand the purpose of each service, their endpoints, and the basic concepts for making requests, including authentication methods.Services Overview#
1. Data Management API
The Data Management service provides APIs to handle product or customer records. This includes creating, reading, updating, and deleting product and associated information.2. Document Management API
The Document Management service offers APIs to manage various documents such as invoices, purchase orders, and receipts. You can perform operations like uploading, retrieving, updating, and deleting documents.Environment URLs#
Each service in the Four Way Shop suite has different URLs for test and production environments. It is important to test your API integrations in the test environment before deploying them to production.For detailed information on the specific URLs for each environment, please refer to the appropriate sections in the API documentation. Always ensure to thoroughly test your API integrations in the test environment to avoid any issues in the production environment.Authentication#
Each service in the Four Way Shop suite requires different authentication methods:1. Product Data Management API
This service uses token-based authentication. To access the API, you need an API token included in your HTTP requests.2. Document Management API
This service uses basic authentication with a username and password.For more detailed information on the authentication methods and how to obtain the necessary credentials, please refer to the specific chapters dedicated to each service in the documentation.API Rate Limits#
Both services within the Four Way Shop suite have API rate limits to ensure fair usage and maintain optimal performance. These limits restrict the number of API calls that can be made within a certain time frame.To understand the specific rate limits for each service and how they may impact your integration, please refer to the detailed sections in the API documentation dedicated to rate limits.API Status#
Each API in this documentation is associated with a status indicator that provides crucial information about its current development phase. The status can be one of the following:Designing: The API is in the conceptual phase. Significant changes are expected, and the API is not ready for use.
Developing: The API is under active development. The implementation details might change, and it should not be used in a production environment.
Testing: The API is being tested for stability and reliability. It is not yet stable and should be avoided in production.
Deprecated: The API is outdated and is scheduled for removal. It should be replaced with a newer version as soon as possible.
In this example, the "Get Attribute Types" API is in the "Designing" state.APIs in any of these states should not be used in a production environment. Always check the status of an API before starting an integration to ensure that you are using a stable and supported version.
Under construction#
If the icon 🚧 is present at the beginning of a chapter, it indicates that the chapter is still under construction and the content is subject to change. 