Skip to main content

Foxdeli API Authentication

Foxdeli API utilizes JSON Web Tokens (JWT) for authentication, ensuring secure and authorized access. To interact with the API, you'll need to obtain API credentials.

Here's how to get started​

  • Create API Credentials: Navigate to Foxdeli Settings and locate the API Connections section. Generate a new API username and password pair.

  • Use Credentials for Authentication: These credentials are used to generate JWT tokens via the Foxdeli AUTH API. Refer to the API documentation for detailed instructions on obtaining tokens using your username and password.

Sandbox Environment access

For credentials in the sandbox environment, navigate to the Sandbox Settings page and generate a new API username and password pair.

JWT Token Functionality:​

The JWT authentication process involves two tokens:

  • Access Token: Valid for 10 minutes and used to access API resources.
  • Refresh Token: Valid for up to 24 hours (unless used) and used to obtain new access tokens once the initial one expires. This approach guarantees that only authorized users access the API and that user data remains protected, as expired or used tokens become invalid.
Reminder

Remember to re-authenticate with your user credentials to obtain new tokens if the refresh token expires (after 24 hours of inactivity).