API Docs

Intray API

Please find the api endpoints at api.intray.eu.

GET /

Response:

Status code 200
Headers: []
Supported content types are:
- text/html;charset=utf-8
- text/html
Example (text/html;charset=utf-8, text/html):

Documentation (In HTML).

GET /access-key

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

[]

Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "created": "2018-02-10T00:00:42Z",
        "name": "Example Text",
        "permissions": []
    }
]

Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "created": "2018-02-10T00:00:42Z",
        "name": "Example Text",
        "permissions": []
    },
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "created": "2018-02-10T00:00:42Z",
        "name": "Example Text",
        "permissions": []
    }
]

Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "created": "2018-02-10T00:00:42Z",
        "name": "Example Text",
        "permissions": [
            "PermitAdd"
        ]
    }
]

Example (application/json):

[
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "created": "2018-02-10T00:00:42Z",
        "name": "Example Text",
        "permissions": []
    },
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "created": "2018-02-10T00:00:42Z",
        "name": "Example Text",
        "permissions": []
    },
    {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "created": "2018-02-10T00:00:42Z",
        "name": "Example Text",
        "permissions": []
    }
]

POST /access-key

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

Supported content types are:
- application/json
Example (application/json):

{
    "addAccessKeyPermissions": [],
    "addAccessKeyName": "Example Text"
}

Example (application/json, application/json):

{
    "addAccessKeyPermissions": [
        "PermitAdd"
    ],
    "addAccessKeyName": "Example Text"
}

Example (application/json):

{
    "addAccessKeyPermissions": [
        "PermitGetAccountInfo"
    ],
    "addAccessKeyName": "Example Text"
}

Example (application/json):

{
    "addAccessKeyPermissions": [
        "PermitAdd"
    ],
    "addAccessKeyName": "Example Text"
}

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.

{
    "accessKeyCreatedKey": "4aee3b77817d31674fd97fe13416140a",
    "accessKeyCreatedCreatedTimestamp": "2018-02-10T00:00:42Z",
    "accessKeyCreatedUUID": "00000000-0000-0000-0000-000000000000"
}

DELETE /access-key/:uuid

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

uuid: The UUID of the access key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.

GET /access-key/:uuid

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

uuid: The UUID of the access key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

{
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "name": "Example Text",
    "permissions": []
}

Example (application/json, application/json):

{
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "name": "Example Text",
    "permissions": [
        "PermitAdd"
    ]
}

Example (application/json):

{
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "name": "Example Text",
    "permissions": [
        "PermitGetAccountInfo"
    ]
}

Example (application/json):

{
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "name": "Example Text",
    "permissions": [
        "PermitAdd"
    ]
}

DELETE /account

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.

GET /account

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

{
    "status": {
        "status": "not-paid",
        "items-left": 42
    },
    "admin": false,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "count": 42,
    "username": "Example Text",
    "last-login": null
}

Example (application/json):

{
    "status": {
        "status": "paid",
        "until": "2018-02-10T00:00:42Z"
    },
    "admin": false,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "count": 42,
    "username": "Example Text",
    "last-login": null
}

Example (application/json):

{
    "status": {
        "status": "not-paid",
        "items-left": 42
    },
    "admin": true,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "count": 42,
    "username": "Example Text",
    "last-login": null
}

Example (application/json):

{
    "status": {
        "status": "no-payment-necessary"
    },
    "admin": false,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "count": 42,
    "username": "Example Text",
    "last-login": null
}

Example (application/json):

{
    "status": {
        "status": "paid",
        "until": "2018-02-10T00:00:42Z"
    },
    "admin": true,
    "uuid": "00000000-0000-0000-0000-000000000000",
    "created": "2018-02-10T00:00:42Z",
    "count": 42,
    "username": "Example Text",
    "last-login": null
}

POST /account

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

Supported content types are:
- application/json
Example (application/json):

{
    "old-passphrase": "Example Text",
    "new-passphrase": "Example Text"
}

Response:

Status code 204
Headers: []
Supported content types are:
- application/json;charset=utf-8
- application/json
Example (application/json;charset=utf-8, application/json):

POST /intray/item

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

Supported content types are:
- application/json
Example (application/json):

{
    "data": "SGVsbG8gV29ybGQh",
    "type": "text"
}

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.

"00000000-0000-0000-0000-000000000000"

DELETE /intray/item/:uuid

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

uuid: The UUID of the item

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.

GET /intray/item/:uuid

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Captures:

uuid: The UUID of the item

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.

{
    "contents": {
        "data": "SGVsbG8gV29ybGQh",
        "type": "text"
    },
    "created": "2018-02-10T00:00:42Z",
    "id": "00000000-0000-0000-0000-000000000000"
}

GET /intray/items

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

[]

Example (application/json):

[
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

Example (application/json):

[
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

Example (application/json):

[
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

Example (application/json):

[
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    },
    {
        "contents": {
            "data": "SGVsbG8gV29ybGQh",
            "type": "text"
        },
        "created": "2018-02-10T00:00:42Z",
        "id": "00000000-0000-0000-0000-000000000000"
    }
]

GET /intray/show-item

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

null

Example (application/json):

{
    "contents": {
        "data": "SGVsbG8gV29ybGQh",
        "type": "text"
    },
    "created": "2018-02-10T00:00:42Z",
    "id": "00000000-0000-0000-0000-000000000000"
}

GET /intray/size

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.

POST /intray/sync

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Request:

Supported content types are:
- application/json
Example (application/json):

{
    "deleted": [],
    "added": {},
    "synced": []
}

Example (application/json):

{
    "deleted": [
        "00000000-0000-0000-0000-000000000000"
    ],
    "added": {},
    "synced": []
}

Example (application/json):

{
    "deleted": [],
    "added": {
        "0": {
            "contents": {
                "data": "SGVsbG8gV29ybGQh",
                "type": "text"
            },
            "created": "2018-02-10T00:00:42Z"
        }
    },
    "synced": []
}

Example (application/json):

{
    "deleted": [],
    "added": {},
    "synced": [
        "00000000-0000-0000-0000-000000000000"
    ]
}

Example (application/json):

{
    "deleted": [
        "00000000-0000-0000-0000-000000000000"
    ],
    "added": {
        "0": {
            "contents": {
                "data": "SGVsbG8gV29ybGQh",
                "type": "text"
            },
            "created": "2018-02-10T00:00:42Z"
        }
    },
    "synced": []
}

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

{
    "client-added": {},
    "server-deleted": [],
    "server-added": {},
    "client-deleted": []
}

Example (application/json):

{
    "client-added": {},
    "server-deleted": [
        "00000000-0000-0000-0000-000000000000"
    ],
    "server-added": {},
    "client-deleted": []
}

Example (application/json):

{
    "client-added": {},
    "server-deleted": [],
    "server-added": {},
    "client-deleted": [
        "00000000-0000-0000-0000-000000000000"
    ]
}

Example (application/json):

{
    "client-added": {},
    "server-deleted": [],
    "server-added": {
        "00000000-0000-0000-0000-000000000000": {
            "contents": {
                "data": "SGVsbG8gV29ybGQh",
                "type": "text"
            },
            "created": "2018-02-10T00:00:42Z"
        }
    },
    "client-deleted": []
}

Example (application/json):

{
    "client-added": {},
    "server-deleted": [
        "00000000-0000-0000-0000-000000000000"
    ],
    "server-added": {},
    "client-deleted": [
        "00000000-0000-0000-0000-000000000000"
    ]
}

GET /intray/uuids

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

[]

Example (application/json):

[
    "00000000-0000-0000-0000-000000000000"
]

Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

Example (application/json):

[
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000",
    "00000000-0000-0000-0000-000000000000"
]

POST /login

Request:

Supported content types are:
- application/json
Example (application/json):

{
    "username": "Example Text",
    "password": "Example Text"
}

Response:

Status code 204
Headers: [("Set-Cookie","Example Text")]
Supported content types are:
- application/json;charset=utf-8
- application/json
Example (application/json;charset=utf-8, application/json):

GET /permissions

Authentication

This part of the API is protected by JSON Web Tokens (JWTs)

Clients must supply the following data A JWT Token signed with this server's key

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

[]

Example (application/json, application/json):

[
    "PermitAdd"
]

Example (application/json):

[
    "PermitGetAccountInfo"
]

Example (application/json):

[
    "PermitAdd"
]

GET /pricing

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Example (application/json):

null

Example (application/json):

{
    "trial-period": 30,
    "plan": "plan_FiN2Zsdv0DP0kh",
    "max-items-free": 5,
    "publishable-key": "pk_test_zV5qVP1IQTjE9QYulRZpfD8C00cqGOnQ91",
    "currency": "chf",
    "price": 100
}

POST /register

Request:

Supported content types are:
- application/json
Example (application/json):

{
    "name": "Example Text",
    "password": "Example Text"
}

Response:

Status code 200
Headers: []
Supported content types are:
- application/json
Response body as below.