Skip to main content

Getting started

Welcome to the Foxdeli API documentation. Our API provides 3rd party systems with access to Foxdeli services. This documentation is intended for developers who wish to integrate the Foxdeli API into their applications.

The documentation for Foxdeli API is designed to make use of the OpenAPI specification format, which provides a standardized and easily navigable framework for understanding the API's features and functions.

One of the key benefits of this approach is that it allows for the generation of client code, which can help to simplify and streamline the development process. By making use of the OpenAPI spec format, developers can more easily understand how the API works, and can use this knowledge to create efficient and effective client applications.

To download the API spec file, users can simply make use of the export button provided within the documentation. This will generate a file that can be used to generate client code or to more easily explore the API's features and functions.

Overall, the use of the OpenAPI specification format in Foxdeli API documentation provides a powerful tool for developers, enabling them to quickly and easily create client applications while ensuring consistency and accuracy in their interactions with the API.

Ready made modules

Did you know there are prebuilt zero effort modules that can be integrated into selected e-commerce solutions?

Status and error codes​

Status codes are used to indicate the result of an API request. Each response from the API includes a status code that indicates whether the request was successful or encountered an error. There are several standard HTTP status codes that Foxdeli API is using, including:

  • 200 OK: The request was successful and the API returned the expected data.
  • 201 Created: The request was successful and a new resource was created.
  • 204 No Content: The request was successful, but there is no data to return.
  • 400 Bad Request: The request was invalid or malformed - usually a constraint violation like missing required field or malformed value.
  • 401 Unauthorized: The request requires authentication, but the provided token was invalid or missing.
  • 403 Forbidden: The authenticated user does not have access to the requested resource.
  • 404 Not Found: The requested resource could not be found.
  • 500 Internal Server Error: An error occurred on the server.

Look into API reference for further details of possible erros for each call.

Error response format​

FOxdeli API employs the RFC7808 standard for handling errors in the form of application/problem+json. In the event of an error occurring, the API will generate a response in the application/problem+json format, which will contain a comprehensive description of the error and its underlying cause. This approach ensures that clients interacting with the API can receive detailed and accurate information about the issue, allowing them to quickly and effectively troubleshoot and resolve any problems that may arise. By adhering to the RFC7808 standard, the API delivers a standardized and consistent error handling approach that promotes ease of use, reliability, and scalability.

API Authentication​

To ensure secure and authorized access to its services, Foxdeli API has implemented the use of JSON Web Tokens (JWT) for authentication. This industry-standard approach provides a reliable and effective way to authenticate users and ensure that only authorized individuals are able to access the API's resources.

To obtain access to Foxdeli API, you will first need to create API credentials in Foxdeli Settings. This involves creating a set of unique and secure credentials that will be used to authenticate your requests and allow you to access the API's features and functions. Once you have created your API credentials, you can use them to authenticate your requests and gain access to the resources provided by the Foxdeli API.

Token lifecycle​

Through the use of Foxdeli AUTH API, it is possible to exchange user credentials for a pair of tokens - an access token and a refresh token. The access token remains valid for a period of 10 minutes, after which it must be renewed using the refresh token. On the other hand, the refresh token is valid for a period of 24 hours.

Once the refresh token expires, it is necessary to re-authenticate using the user credentials to obtain a fresh pair of tokens. This approach ensures that only authorized individuals have access to the Foxdeli API's resources, and that user data remains secure and protected.

Environments​

There are two publicly available environments that you can use:

info

Most API models also contain a testData flag. Data marked with testData are subject for periodical deletion and shall be used for testing purposes only.

Generate API client​

The Foxdeli API reference offers a useful feature that enables the export of OpenAPI specification files, which can be utilized to generate client code using the OpenAPI CLI. This client code can then be employed to implement the necessary business logic for connecting to the Foxdeli API on the user's side.

The OpenAPI CLI offers a diverse range of client generators in various programming languages, making it a versatile and flexible option for developers. By making use of this tool, developers can quickly and easily create client applications that effectively interact with the Foxdeli API, allowing for seamless integration with their existing systems and applications.

Overall, the availability of OpenAPI spec files and the OpenAPI CLI client generator makes the process of integrating with Foxdeli API simpler, more streamlined, and more accessible to developers of all levels of experience and expertise.