API Documentation - vCard Hosting from vCrd.co

vCrd.co has an API that allows you to access your account's information outside of our interface (great for hooking it up to existing HR systems!). All you will need is your API Key from within your 'Settings' screen.

All API requests will have their endpoint as: https://vcardhosting.com/api/.

GET /getvCards.php

`key`	Required	Your API key
`format`	Required	Available Options: xml, php, json
`callback`	Optional	The JSONP callback function

Returns list of vCards for the particluar account specified by key

<root>
   <status>200</status>
   <message>vcrd.co API</message>
   <link>http://vcardhosting.com/docs/api/</link>
   <request>
      <method>getvCards</method>
      <format>xml</format>
      <key>111111111111111111</key>
      <date>2012-09-15 10:11:26</date>
   </request>
   <cards>
      <item>
         <id>16</id>
         <url>http://vcrd.co/ccagle8/16</url>
         <title>My vCard</title>
         <first_name>Joe</first_name>
         <last_name>Schmoe</last_name>
         <organization>Example, Inc.</organization>
         <job_title>CEO</job_title>
         <city>Pittsburgh</city>
         <state>PA</state>
         <country>US</country>
         <email>my@email.com</email>
         <website>http://example.me</website>
         <phone>412-996-5555</phone>
      </item>
   </cards>
</root>

GET /getvCard.php

`key`	Required	Your API key
`format`	Required	Available Options: xml, php, json
`callback`	Optional	The JSONP callback function
`id`	Required	The ID of the vCard to view

Returns the specified vCard in the format you choose

<root>
   <status>200</status>
   <message>vcrd.co API</message>
   <link>http://vcardhosting.com/docs/api/</link>
   <request>
      <method>getvCard</method>
      <format>xml</format>
      <key>111111111111111111</key>
      <date>2012-09-15 10:11:26</date>
   </request>
   <cards>
      <item>
         <id>16</id>
         <url>http://vcrd.co/ccagle8/16</url>
         <title>My vCard</title>
         <first_name>Joe</first_name>
         <last_name>Schmoe</last_name>
         <organization>Example, Inc.</organization>
         <job_title>CEO</job_title>
         <city>Pittsburgh</city>
         <state>PA</state>
         <country>US</country>
         <email>my@email.com</email>
         <website>http://example.me</website>
         <phone>412-996-5555</phone>
      </item>
   </cards>
</root>

GET /getStats.php

`key`	Required	Your API key
`format`	Required	Available Options: xml, php, json
`callback`	Optional	The JSONP callback function

Exports the aggregate usage statistics for all the vCards within the account associated with key.

<root>
  <status>200</status>
  <message>vcrd.co API</message>
  <link>http://vcardhosting.com/docs/api/</link>
  <request>
    <method>getSttats</method>
    <format>xml</format>
    <key>111111111111111111</key>
    <date>2012-09-29 08:15:42</date>
  </request>
  <cards>
    <card_36>
      <id>36</id>
      <url>http://vcrd.co/ccagle8/36</url>
      <web>158</web>
      <qr>16</qr>
      <dl>12</dl>
    </card_36>
  </cards>
</root>

GET /updatevCard.php

`key`	Required	Your API key
`format`	Required	Available Options: xml, php, json
`callback`	Optional	The JSONP callback function
`id`	Required	The ID of the vCard to update
`xml`	Required	The data to update the vCrd with. Valid XML only.

Updates the vCard with id with the data inside xml.
★ This API is only available to Business accounts.

<root>
   <status>200</status>
   <message>Update Successful</message>
   <link>http://vcardhosting.com/docs/api/</link>
   <request>
      <method>updatevCards</method>
      <format>xml</format>
      <key>111111111111111111</key>
      <vcard_id>36</vcard_id>
      <date>2012-09-21 01:29:42</date>
   </request>
   <data>
      <id>36</id>
   </data>
</root>

GET /createvCard.php

`key`	Required	Your API key
`format`	Required	Available Options: xml, php, json
`callback`	Optional	The JSONP callback function
`xml`	Required	The data to update the vCrd with. Valid XML only.

Creates a new vCard within the account of key with the data inside xml.
★ This API is only available to Business accounts.

<root>
   <status>200</status>
   <message>Created Successful</message>
   <link>http://vcardhosting.com/docs/api/</link>
   <request>
      <method>updatevCards</method>
      <format>xml</format>
      <key>111111111111111111</key>
      <vcard_id>36</vcard_id>
      <date>2012-09-21 01:29:42</date>
   </request>
   <data>
      <id>36</id>
      <url>http://vcrd.co/ccagle8/36</url>
   </data>
</root>

GET /deletevCard.php

`key`	Required	Your API key
`format`	Required	Available Options: xml, php, json
`callback`	Optional	The JSONP callback function
`id`	Required	The ID of the vCard to delete

Permanently deletes the vCard with the ID of id.
★ This API is only available to Business accounts.

<root>
   <status>200</status>
   <message>Deleted Successful</message>
   <link>http://vcardhosting.com/docs/api/</link>
   <request>
      <method>updatevCards</method>
      <format>xml</format>
      <key>111111111111111111</key>
      <vcard_id>36</vcard_id>
      <date>2012-09-21 01:29:42</date>
   </request>
   <data>
      <id>36</id>
   </data>
</root>