Overview

As the public API is restricted to licensed users, it's mandatory to pass a token parameter in order to check whether the request is valid or not.

For that, the first method to learn to use is getToken explained below.

It gets the token which is needed to work with the public API. Once you obtain the token, you must pass it as a parameter in every request.

Input

{
    APIKey: 22e596e3faf11b1222e596e67ea9673faf11b16
}

Output

A JSON object with this content:

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps
}

Images

It obtains the total number of images in the system.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps
}

Output

A JSON object with this content:

{
    totalimages: 10
}

It obtains the images in the system in a paginated way.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps
    page: 0,
    count: 10
}

Output

An array of JSON objects (10 in this example) like this:

[ {
    id: BJPGf8Bdf,
    entityname: girl_BJPGf8Bdf.png,
    creation: 1519899150847,
    width: 256,
    heigth: 256,
    size: 86949,
    format: png
} ... ]

It deletes an image from the system. Be careful! This action also removes every Picly associated to that image.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    imageid: rJwOcjqdG
}

Output

A JSON object with this content:

{
    success: true
    message: ""
}

{
    sucess: false,
    message: Error deleting image
}

Piclys

It obtains the total number of Piclys in the system.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps
}

Output

A JSON object with this content:

{
    totalpiclys: 10
}

It creates a new Picly. If the Picly is already created, simply return its id.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    request: /resize:w(320)/rJwOcjqdG
}

Output

A JSON object with this content:

{
    success: true,
    shortrequestid: HJeBAyn-G
}

{
    success: false,
    shortrequestid: "",
    message: Error creating picly
}

It deletes a Picly from the system.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    requestid: 1500d00c19d7cde627396840fbeafed5
}

Output

A JSON object with this content:

{
    success: true,
    message: ""
}

{
    success: false,
    message: Error deleting picly
}

It obtains all Piclys associated to an image.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    imageid: rJwOcjqdG
}

Output

A JSON object with this content:

{
    requestid: 1500d00c19d7cde627396840fbeafed5,
    originalimageid: rJwOcjqdG,
    creation: 1520332010700,
    requesturl: /resize:w(320)/rJwOcjqdG,
    shortrequestid: HJeBAyn-G
}

Upload

It uploads an image to the system through its URL directly.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    url: https://www.images.com/sample.jpg
}

Output

A JSON object with this content:

{
    imageid: BJPGf8Bdf,
    filename: girl_BJPGf8Bdf.png,
    success: true,
    message: ""
}

{
    imageid: BJPGf8Bdf,
    filename: girl_BJPGf8Bdf.png,
    success: false,
    message: Image duplicated
}

It starts an image upload to the system. It returns a code to identify the upload process.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    filename: htts://www.images.com/sample.jpg,
    filesize: ""
}

Output

A JSON object with this content:

{
    uploadid: BJPGf8Bdf
}

It indicates the finish of the upload of the blocks.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    uploadid: ""
}

Output

A JSON object with this content:

{
    result: true,
    imageid: id,
    filename: new_image.jpg,
    message: ""
}

{
    result: false,
    imageid: id,
    filename: new_image.jpg,
    message: Error when uploading image
}

It adds a new block to the file that is uploading.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps,
    chunkBuffer: chunk,
    chunkNumber: 0,
    chunkSize: 15486,
    uploadid: id
}

Output

A JSON object with this content:

{
    result: true,
}

Here you find an example of use where it shows how upload an image using the methods explained above.

"use strict"
var fs = require("fs");
var request = require("request");
var _ = require("lodash");

var TOKEN = "";
var UPLOADID = "";

const URLNEWUPLOAD = "https://localhost:3000/piclyapi/newupload";
const URLNEWCHUNK = "https://localhost:3000/piclyapi/newchunk";
const URLCOMPLETEUPLOAD = "https://localhost:3000/piclyapi/completeupload";
const URLGETTOKEN = "https://localhost:3000/piclyapi/gettoken";
const FILESPATH = "./folderwithimages/"

function startUpload(file){
    return new Promise((resolve, reject) => {
        file.token = TOKEN;
        console.log("Request new upload")
        request({
            url: URLNEWUPLOAD,
            method: "POST",
            json: true,
            body: file
        }, (err, response, body)=>{
            if(!!err){
                reject(err);
            }else{
                resolve(body.uploadid);
            }
        });
    });
}

function getToken(){
    return new Promise((resolve, reject) => {
        let jsonobject = {
            APIKey: "22e596e67ea9673faf11b1222e596e67ea9673faf11b11"
        }
        console.log("Get Token")
        request({
            url: URLGETTOKEN,
            method: "POST",
            json: true,
            body: jsonobject
        }, (err, response, body)=>{
            if(!!err){
                reject(err);
            }else{
                resolve(body)
            }
        });
    });
}

function sendChunks(file){
    return new Promise((resolve, reject) => {
        var fileBytes = fs.readFileSync(FILESPATH + file.filename);
        var chunks = _.chunk(fileBytes, 100);

        console.log(`Sending chunks, ${chunks.length} in total`);

        var promises = [];
        var chunkNumber = 0;
        chunks.forEach((chunk)=>{
            let chunkSize = chunk.length; 
            promises.push(sendOneChunck(chunk, chunkNumber, chunkSize))
            chunkNumber++;
        })
        Promise.all(promises).then(()=>{
            resolve()
        });
    });
}

function sendOneChunck(chunk, chunkNumber, chunkSize){
    return new Promise((resolve, reject) => {
        var jsonobject = {
            token: TOKEN,
            chunkBuffer: chunk,
            chunkNumber: chunkNumber,
            chunkSize: chunkSize,
            uploadid: UPLOADID
        };

        request({
            url: URLNEWCHUNK,
            method: "POST",
            json: true,
            body: jsonobject
        }, (err, response, body)=>{
            if(!!err){
                reject(err);
            }else{
                resolve();
            }
        });
    });
}

function completeUpload(){
    return new Promise((resolve, reject) => {
        var jsonobject = {
            token: TOKEN,
            uploadid: UPLOADID
        }

        console.log("Complete upload")

        request({
            url: URLCOMPLETEUPLOAD,
            method: "POST",
            json: true,
            body: jsonobject
        }, (err, response, body)=>{
            if(!!err){
                reject(err);
            }else{
                resolve(body);
            }
        });
    });
}

var files = fs.readdirSync(FILESPATH);
console.log(files);

var filestat = fs.statSync(FILESPATH + files[1]);
var file = {
    filename: files[0],
    filesize: filestat.size
}

getToken().then((body)=>{
    TOKEN = body.token

    console.log("Token: ", TOKEN);

    return startUpload(file);
}).then((uploadid)=>{
    UPLOADID = uploadid;

    console.log("UploadId: ", UPLOADID);

    return sendChunks(file);
}).then(()=>{
    console.log("All chunks send");

    return completeUpload();
}).then((image)=>{
    console.log("Image Uploaded: ",image);
}).catch((err)=>{
    console.log(err);
});

Others

It obtains all the plugins registered in the system.

Input

{
    token: xMjIyZTU5NmU2N2VhOTY3M2ZhZjExYjEyIiwiaWF0IjoxNTE5OTAyMTg2LCJleHAiOjE1MTk5ODg1ODZ9.fYGFujkbeGF1vDsZ7N5aH0Pp_ug0Y3f4bayIschOjps
}

Output

An array of JSONs which have this content:

[
{
    name: aging,
    info: Picly module for apply agning effect
},
...
]