api_home

The API homepage is the starting point for the Foxy hypermedia API. The link relations returned depend on the scope of your OAuth token:

  • No token or client-only token: Links to create a client, create a user, and the token endpoint.
  • User-scoped token: Links to the authenticated user, their stores, and (if a store is selected) the current store.
  • Store-scoped token: All of the above plus a link to the current store and the encode endpoint.

As a hypermedia API, this is where you begin navigating. Follow the link relations to discover available resources rather than constructing URLs manually.

Actions

GET View the API homepage and discover available link relations
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (1)

message String · Read-only

A welcome message with basic guidance for using the API.

Link Relations (12)

self Your API starting point.
fx:property_helpers GET Various helpers used for determining valid property values.
fx:token POST The OAuth token endpoint.
https://api.foxycart.com/rels Custom Link Relationships supported by this API.
fx:create_client POST Create a new OAuth client.

Only present when no client is associated with the current token.

fx:client GET PATCH PUT The current client for your authentication token.

Only present when a client is associated with the token but no user or store is set.

fx:create_user POST Create a new user.

Only present when a client exists but no user is associated with the token.

fx:user GET PATCH PUT DELETE The authenticated user.

Only present when a user is associated with the token.

fx:stores GET POST The stores accessible to the authenticated user.

Only present when a user is associated with the token.

fx:store GET PATCH PUT DELETE The current store for your authentication token.

Only present when both a user and store are associated with the token.

fx:reporting GET Reporting endpoint.

Only present when a client, user, or store is associated with the token.

fx:encode POST POST here to encode a body of HTML for use with HMAC cart encryption.

Only present when a store is associated with the token.

https://api.foxycart.com/

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/",
      "title": "Your API starting point."
    },
    "fx:property_helpers": {
      "href": "https://api.foxycart.com/property_helpers",
      "title": "Various helpers used for determining valid property values."
    },
    "fx:token": {
      "href": "https://api.foxycart.com/token",
      "title": "The OAuth token endpoint."
    },
    "https://api.foxycart.com/rels": {
      "href": "https://api.foxycart.com/rels",
      "title": "Custom Link Relationships supported by this API."
    }
  },
  "message": "Welcome to the FoxyCart API! Our hope is to be as self-documenting and RESTful as possible. Please let us know if you have any questions by emailing us at helpdesk@foxycart.com. Your first action should be to create an OAuth Client, then a user, followed by a store."
}