qimg API API documentation version v1

https://comem-qimg.herokuapp.com/api

/images

Image upload resource.

get post

get

Retrieve the list of uploaded images.

If you are authenticated as a user, this will return only the images you uploaded and you will not see the tokenId property.

post

Upload an image.

Use the application/json content type to upload base64-encoded data.

Use the multipart/form-data content type to upload an image file. Send the image file as the image field.

Images cannot be larger than 2MB. (When sending base64-encoded image data, the entire JSON payload cannot be larger than 2MB.)

Quota

If you have reached the image quota (10 by default), your oldest uploaded images will be purged.

Upload an image.

Use the application/json content type to upload base64-encoded data.

Use the multipart/form-data content type to upload an image file. Send the image file as the image field.

Images cannot be larger than 2MB. (When sending base64-encoded image data, the entire JSON payload cannot be larger than 2MB.)

Quota

If you have reached the image quota (10 by default), your oldest uploaded images will be purged.

Headers

  • Authorization: required (string)

    The Authorization header must contain the administrator's bearer token. Users are not allowed access to this resource.

    Authorization: Bearer $BEARER_TOKEN

Body

Media type: application/json

Type: object

Example:

{
  "data": "YXdvNHQgOHNpOGhnIHM4aHQ="
}

Media type: multipart/form-data

Type: object

Example:

Content-Type: multipart/form-data; boundary=AaB03x

--AaB03x
Content-Disposition: form-data; name="image"; filename="image.png"
Content-Type: image/png

... contents of image.png ...
--AaB03x--

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{
  "createdAt": "2015-03-12T19:54:01.284Z",
  "id": "2f0f532e-44cc-411a-837c-a0061b2be7fb",
  "size": 456203,
  "url": "https://api.example.com/images/2f0f532e-44cc-411a-837c-a0061b2be7fb.png"
}

HTTP status code 401

You have not provided authentication credentials or they are invalid or have expired. Make sure you are sending the Authorization header and that it contains a valid bearer token (e.g. Authorization: Bearer 9q84nv98n) that has not expired.

HTTP status code 403

You were authenticated but your role does not give you access to this resource.

HTTP status code 413

The uploaded image is too large.

Body

Media type: text/plain

Type: object

Example:

The uploaded image is too large (the limit is 2MB).

HTTP status code 415

The body of the request is in an unsupported format.

Body

Media type: text/plain

Type: object

Example:

The request must have content type application/json or multipart/form-data.

HTTP status code 422

There are errors in the body of the request.

For the application/json content type, this happens if the "data" property is missing. For the multipart/form-data content type, this happens if the "image" field is not set.

Body

Media type: text/plain

Type: object

Example:

The "data" property must contain the base64-encoded image data.

The "image" field is not set.

delete

delete

Delete an uploaded image.

If you are authenticated as a user, you must be the one who uploaded the image.

Delete an uploaded image.

If you are authenticated as a user, you must be the one who uploaded the image.

URI Parameters

  • imageId: required (string)

Headers

  • Authorization: required (string)

    The Authorization header must contain a user's or the administrator's bearer token.

    Authorization: Bearer $BEARER_TOKEN

HTTP status code 204

The token and associated images have been successfully deleted.

HTTP status code 401

You have not provided authentication credentials or they are invalid or have expired. Make sure you are sending the Authorization header and that it contains a valid bearer token (e.g. Authorization: Bearer 9q84nv98n) that has not expired.

HTTP status code 404

No image correspond to the specified ID, or someone else uploaded that image.

Body

Media type: text/plain

Type: object

Example:

No image found with ID "682f1d0e-b243-4ed0-9ae2-66e9b4b51193".

/tokens

Token management resource. The administrator can create tokens that users can use for authentication with the image resources.

get post

get

Retrieve the list of authentication tokens.

post

Create a user authentication token. This token can be used to upload and list images as a user.

Tokens are only valid for a limited time. You can specify an optional lifetime property (in seconds) which defaults to 2,592,000 (30 days). It must be at least 1 second and at most 31,536,000 seconds (365 days).

You can provide an optional name property (up to 50 characters long).

Create a user authentication token. This token can be used to upload and list images as a user.

Tokens are only valid for a limited time. You can specify an optional lifetime property (in seconds) which defaults to 2,592,000 (30 days). It must be at least 1 second and at most 31,536,000 seconds (365 days).

You can provide an optional name property (up to 50 characters long).

Headers

  • Authorization: required (string)

    The Authorization header must contain the administrator's bearer token. Users are not allowed access to this resource.

    Authorization: Bearer $BEARER_TOKEN

Body

Media type: application/json

Type: object

Example:

{
  "lifetime": 2592000,
  "name": "foo"
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{
  "createdAt": "2015-03-12T20:08:33.491Z",
  "expiresAt": "2015-04-11T20:08:33.491Z",
  "id": "b89505ec-f5de-4fdd-9732-a4e3f40724ac",
  "lifetime": 2592000,
  "name": "foo",
  "token": "BjgUp95+mueexr6aPIw3h6LIkq8Tx19pgTEI1X0XxsghxTWhhwlKBgKnwTTQiR/mvU3eglIHe4ecYQX4yeSQ+fGiuLZ903Kh/wsCSraetxB5UHtsJCBl2FSmSvdxSrpNBBnnRYe6HClbDukx4atwdEBEktEQ2xR+RBGeA16ZCBA="
}

HTTP status code 401

You have not provided authentication credentials or they are invalid or have expired. Make sure you are sending the Authorization header and that it contains a valid bearer token (e.g. Authorization: Bearer 9q84nv98n) that has not expired.

HTTP status code 403

You were authenticated but your role does not give you access to this resource.

HTTP status code 422

There are errors in the body of the request.

This can happen if

  • the lifetime is not an integer, is less than one, or is more than 365 days;
  • the name is not a string, or longer than 50 characters.

Body

Media type: text/plain

Type: object

Example:

The "lifetime" property must be an integer.

The "lifetime" property must be greater than zero.

The "lifetime" property must be less than or equal to 31,536,000 (365 days).

The "name" property must be a string.

The "name" property must not be longer than 50 characters.

delete

delete

Delete an authentication token.

All images linked to that user will be purged as well.

Delete an authentication token.

All images linked to that user will be purged as well.

URI Parameters

  • tokenId: required (string)

Headers

  • Authorization: required (string)

    The Authorization header must contain the administrator's bearer token. Users are not allowed access to this resource.

    Authorization: Bearer $BEARER_TOKEN

HTTP status code 204

The token and associated images have been successfully deleted.

HTTP status code 401

You have not provided authentication credentials or they are invalid or have expired. Make sure you are sending the Authorization header and that it contains a valid bearer token (e.g. Authorization: Bearer 9q84nv98n) that has not expired.

HTTP status code 403

You were authenticated but your role does not give you access to this resource.

HTTP status code 404

No token correspond to the specified ID.

Body

Media type: text/plain

Type: object

Example:

No token found with ID "cf8eb01b-0b39-4355-9226-7a858f5d6172".