integration : Foxy hAPI

integration

Description

An integration represents an active OAuth refresh token with the current store. Each OAuth integration that has been activated and approved for the current store will be represented as an integration. Integrations can be deleted which will delete the refresh token from our system.

When deleting an integration, you will also be deleting any access tokens with the same client_id, user_uri, and scope. Warning: If you delete the integration your API client is currently using, you will have to re-authenticate your client via the OAuth Code Grant process.

Interact with this resource

To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.

Actions

GET: View an integration
DELETE: Delete an integration
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

Property	Description	Type	Constraints
user_uri	A full API URI of the user resource used in this relationship. When working with hypermedia, it's important to save URIs and not just numeric ids.	URI	Read only
client_id	A unique identifier for this client. Maps to the client_id of the client resource.	String	Read only
scope	The OAuth scope granted to this integration.	String	Read only
expires	When this OAuth refresh token expires.	Timestamp	Read only
project_name	Maps to the project_name of the client resource.	String	Read only
project_description	Maps to the project_description of the client resource.	String	Read only
company_name	Maps to the company_name of the client resource.	String	Read only
company_url	Maps to the company_url of the client resource.	URL	Read only
company_logo	Maps to the company_logo of the client resource.	URL	Read only
contact_name	Maps to the contact_name of the client resource.	String	Read only
contact_email	Maps to the contact_email of the client resource.	String	Read only
added_by_name	Maps to the first_name and last_name of the user resource.	String	Read only
added_by_email	Maps to the email of the user resource.	Email	Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api.foxycart.com/integrations/ae1beea4f8cbc26989a874dec8d9198216555ba6e153545a15641edfe52325aa232ae290c267c92d6a80da9817ed81bb",
            "title": "This OAuth Integration"
        },
        "fx:store": {
            "href": "https://api.foxycart.com/stores/66",
            "title": "This Store"
        },
        "fx:user": {
            "href": "https://api.foxycart.com/users/92",
            "title": "This User"
        },
        "fx:client": {
            "href": "https://api.foxycart.com/clients/2",
            "title": "This Client"
        }
    },
    "user_uri": "https://api.foxycart.com/users/92",
    "client_id": "super_duper_client_id",
    "scope": "user_full_access store_full_access store_id_66",
    "expires": 1752787287,
    "project_name": "My Super Project",
    "project_description": "A really cool project you should be excited about.",
    "company_name": "FoxyCart",
    "company_url": "http://www.foxycart.com",
    "company_logo": "http://www.foxycart.com/assets/templates/v02/slices/foxycart-seo-ecommerce.png",
    "contact_name": "Mr. Example",
    "contact_email": "example@example.com",
    "added_by_name": "First Last",
    "added_by_email": "someone@example.com"
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/integrations/ae1beea4f8cbc26989a874dec8d9198216555ba6e153545a15641edfe52325aa232ae290c267c92d6a80da9817ed81bb" rel="https://api.foxycart.com/rels/integration">
  <link rel="self" href="https://api.foxycart.com/integrations/ae1beea4f8cbc26989a874dec8d9198216555ba6e153545a15641edfe52325aa232ae290c267c92d6a80da9817ed81bb" title="This OAuth Integration"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/66" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/user" href="https://api.foxycart.com/users/92" title="This User"/>
  <link rel="https://api.foxycart.com/rels/client" href="https://api.foxycart.com/clients/2" title="This Client"/>
  <user_uri>https://api.foxycart.com/users/92</user_uri>
  <client_id>super_duper_client_id</client_id>
  <scope>user_full_access store_full_access store_id_66</scope>
  <expires>1752787287</expires>
  <project_name>My Super Project</project_name>
  <project_description>A really cool project you should be excited about.</project_description>
  <company_name>FoxyCart</company_name>
  <company_url>http://www.foxycart.com</company_url>
  <company_logo>http://www.foxycart.com/assets/templates/v02/slices/foxycart-seo-ecommerce.png</company_logo>
  <contact_name>Mr. Example</contact_name>
  <contact_email>example@example.com</contact_email>
  <added_by_name>First Last</added_by_name>
  <added_by_email>someone@example.com</added_by_email>
</resource>

{
    "class": [
        "integration"
    ],
    "properties": {
        "user_uri": "https://api.foxycart.com/users/92",
        "client_id": "super_duper_client_id",
        "scope": "user_full_access store_full_access store_id_66",
        "expires": 1752787287,
        "project_name": "My Super Project",
        "project_description": "A really cool project you should be excited about.",
        "company_name": "FoxyCart",
        "company_url": "http://www.foxycart.com",
        "company_logo": "http://www.foxycart.com/assets/templates/v02/slices/foxycart-seo-ecommerce.png",
        "contact_name": "Mr. Example",
        "contact_email": "example@example.com",
        "added_by_name": "First Last",
        "added_by_email": "someone@example.com"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/integrations/ae1beea4f8cbc26989a874dec8d9198216555ba6e153545a15641edfe52325aa232ae290c267c92d6a80da9817ed81bb"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api.foxycart.com/stores/66"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/user"
            ],
            "href": "https://api.foxycart.com/users/92"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/client"
            ],
            "href": "https://api.foxycart.com/clients/2"
        }
    ],
    "actions": [
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.