Appstore¶

These APIs relate to installing and uninstalling apps.

App relations collection¶

GET¶

Retrieve list of app relations

GET /orgs/{org_pk}/appstore/app-relations/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/appstore/app-relations/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "access_token": "4ef5b29b1f4f35c383bebfccf4bf4d01",
            "app_name": "Shopify integration",
            "created_at": "2015-08-13T09:33:07Z",
            "is_configured": true,
            "name": null,
            "installed_by": {
                "url": "/api/v2/orgs/1/members/1/",
                "email": "[email protected]",
                "first_name": "John",
                "last_name": "Example",
                "is_admin": false,
                "is_owner": false,
                "is_shipper": false,
                "profile_image": null,
                "websocket_channel_id": "cF6EZn1oGtT5X",
                "user_websocket_channel_id": "cF6EZn1oGtT5X",
                "member_websocket_channel_id": "cF6EZn1oGtT5X"
            },
            "unique_id": "",
            "updated_at": "2015-08-13T09:33:07Z",
            "url": "/api/v2/orgs/1/appstore/app-relations/4ef5b29b1f4f35c383bebfccf4bf4d01/"
        }
    ]
}

App relations¶

GET¶

Retrieve app relations details

GET /orgs/{org_pk}/appstore/app-relations/{access_token}/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/appstore/app-relations/2294c6d60bac4eb8be75692cf2432620/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
    "access_token": "4ef5b29b1f4f35c383bebfccf4bf4d01",
    "app_name": "Shopify integration",
    "created_at": "2015-08-13T09:33:07Z",
    "is_configured": true,
    "name": null,
    "installed_by": {
        "url": "/api/v2/orgs/1/members/1/",
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Example",
        "is_admin": false,
        "is_owner": false,
        "is_shipper": false,
        "profile_image": null,
        "websocket_channel_id": "cF6EZn1oGtT5X",
        "user_websocket_channel_id": "cF6EZn1oGtT5X",
        "member_websocket_channel_id": "cF6EZn1oGtT5X"
    },
    "unique_id": "",
    "updated_at": "2015-08-13T09:33:07Z",
    "url": "/api/v2/orgs/1/appstore/app-relations/4ef5b29b1f4f35c383bebfccf4bf4d01/"
}

PATCH¶

Update app relations details

PATCH /orgs/{org_pk}/appstore/app-relations/{access_token}/

Example request:

curl -iL --request PATCH -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/appstore/app-relations/2294c6d60bac4eb8be75692cf2432620/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

data.json:

{
    "name": "My shopify integration",
    "installed_by": null
}

Response 200 (application/json):

{
    "access_token": "4ef5b29b1f4f35c383bebfccf4bf4d01",
    "app_name": "Shopify integration",
    "created_at": "2015-08-13T09:33:07Z",
    "is_configured": true,
    "name": "My shopify integration",
    "installed_by": {
        "url": "/api/v2/orgs/1/members/1/",
        "email": "[email protected]",
        "first_name": "John",
        "last_name": "Example",
        "is_admin": false,
        "is_owner": false,
        "is_shipper": false,
        "profile_image": null,
        "websocket_channel_id": "cF6EZn1oGtT5X",
        "user_websocket_channel_id": "cF6EZn1oGtT5X",
        "member_websocket_channel_id": "cF6EZn1oGtT5X"
    },
    "unique_id": "",
    "updated_at": "2015-08-13T09:33:07Z",
    "url": "/api/v2/orgs/1/appstore/app-relations/4ef5b29b1f4f35c383bebfccf4bf4d01/"
}