SharinPix security token

The SharinPix security token represents an essential element for using SharinPix.

• Structure of SharinPix Parameters
• Using the SharinPix security token

Structure of SharinPix Parameters

Note: To see the effect of each SharinPix Ability on the album, please refer to the following article: SharinPix abilities

The code snippet below demonstrates the structure of the SharinPix Parameters as implemented in an Apex Controller.

public class SharinPixActionDemoCtrl {
    public String parameters {get; set; }
    
    public SharinPixActionDemoCtrl(ApexPages.StandardController controller ) {
        Id accId = controller.getId();
        
        Map<String, Object> params = new Map<String, Object> {
            'exp' => 1000,
            'abilities' => new Map<String, Object> {
                accId => new Map<String, Object> {
                    'Access' => new Map<String, Object> {
                        'see' => true,
                        'image_list' => true,
                        'image_upload' => true,
                        'image_tag' => true,
                        'image_delete' => true
                    },
                    'Tags' => new Map<String, Object> {
                        'car' => new Map<String, String> {
                            'en' => 'car',
                            'fr' => 'voiture'
                        }        
                    },
                    'Action' => new List<String> {
                    	'Add to description'        
                    }
                }
            } 
        };
        parameters = JSON.serialize(params);
    }
    
}

• The keys that make up the params Map structure are explained below.

SharinPix Abilities (abilities)

• SharinPix Abilities , to put in simpler terms, are designations that have the possibility to expand or restrict the features enabled on the SharinPix Album.

'abilities' => new Map<String, Object> {
    accId => new Map<String, Object> {
        'Access' => new Map<String, Object> {
            'see' => true,
            'image_list' => true,
            'image_upload' => true,
            'image_tag' => true,
            'image_delete' => true
        },
        'Tags' => new Map<String, Object> {
            'car' => new Map<String, String> {
                'en' => 'car',
                'fr' => 'voiture'
            }        
        },
        'Action' => new List<String> {
        	'Add to description'        
        }
    }
} 

SharinPix Access (access)

• The Access key represents the rights to specific SharinPix features.

'Access' => new Map<String, Object> {
    'see' => true,
    'image_list' => true,
    'image_upload' => true,
    'image_tag' => true,
    'image_delete' => true
},

SharinPix Tags (Tags)

• Tags - Labels along with their corresponding translations in english(en) and in french(fr).

'Tags' => new Map<String, Object> {
    'car' => new Map<String, String> {
        'en' => 'car',
        'fr' => 'voiture'
    }        
},

SharinPix Actions (Action)

The Action key accepts a SharinPix Action as value.

'Action' => new List<String> {
    	'Add to description'        
}