Vesica API - Requesting Collections

To get a list of collections in your Vesica account you need to send at least three variables (user_api, account_api, demand) with the correct values using the POST method. All the requests must be sent to https://vesica.ws/api/index.php. The demand for requesting piece lists must be "COLLECTION_LIST".

Following is the sample form for requesting a list of collections from your account. All the fields in the form are mandatory and must be filled in with correct values.

<form method="post" action="https://vesica.ws/api/index.php">
     <input type="hidden" name="user_api" value="your-user-api-key" />
     <input type="hidden" name="account_api" value="your-account-api-key" />
     <input type="hidden" name="demand" value="COLLECTION_LIST" />
</form>

In addition to the above mandatory variables, the Vesica API provides the following optional variables which can be used to manipulate / filter the results returned by the API.

Name Description
name To display collections having this value in name.
description To display collections having this value in description.
piece_name To display collections having pieces with name containing this value.
piece_symbolism To display collections having pieces with symbolism containing this value.

If THE submitted values are correct, the Vesica API will return the following XML.

<?xml version="1.0" encoding="iso-8859-1"?>
<response>
     <collection>
          <id></id>
          <name></name>
          <image></image>
          <description></description>
     </collection>
     <collection>
          <id></id>
          <name></name>
          <image></image>
          <description></description>
     </collection>
.........................
</response>

Browse Documenation

Introduction to the API

Requesting Piece Lists

Requesting Piece Details

Adding a Piece

Requesting Collections

Requesting Collection Details

Download Sample Templates

Home    •    Blog    •    Contact Us    •    Developers    •    Education    •    Partners    •    About    •    Help & Support    •    News    •    Privacy Policy    •    Terms of Use

Follow us on Twitterk Join Vesica on Facebook