Homepage My friends My pictures

verifyAccountSecure

Use Case:

Verify that login data is correct.

Examples:

Forwarding to other sites if login was successful. Sorting out by this way is possible.

Foreign words:

none

Requirements:

Requirement is an existing Camheroes account.

Architecture:

HOST & URI

http://www.camheroes.com/api/verifyAccountSecure/

REST (Wikipedia link)

The request should exclusively done via REST. POST as procedure is advisable because login data gets transmitted.

HTTP Procedure

POST

Authentication

User name and password seperated by a colon are needed for authentication, the password has to be SHA1 encrypted. Furthermore these specifications have to be coded in base64.

Example:

http://www.camheroes.com/api/verifyAccountSecure/?lparam=GVjM2FiNDQ2YmE

Error Message

If there occur an error during the request you'll get a XML response with status 0.

Example:

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>0</status>
  </request>
  ...

Server Response (successful):

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>1</status>
  </request>

Server Response (incorrect):

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>0</status>
  </request>

uploadSecure

Use Case:

Upload chosen pictures to Camheroes and allocate them to the stated Camheroes account.

Examples:

Embedding an upload form on different platforms.

Foreign Words:

none

Requirements:

Requirement is an existing Camheroes account.

Architecture:

REST (Wikipedia link)

The request should exclusively done via REST. PUT or POST as procedures are advisable because the picture and login data are transmitted.

HTTP Procedure

PUT or POST

Authentication

User name and password seperated by a colon are needed for authentication, the password has to be SHA1 encrypted. Furthermore these specifications have to be coded in base64. The respective picture must be submitted binary coded and inserted as attachment with the name "uploadfile" and the filename "iphone.jpg". These information can be set by Content-Disposition in HTTP header.

Example:

http://www.camheroes.com/api/uploadSecure?lparam=GVjM2FiNDQ2jN

Error Message

If there occur an error during the request you'll get a XML response with status 0.

Example:

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>0</status>
  </request>
  ...

Server Response (successful):

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>1</status>
  </request>

Server Response (incorrect):

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>0</status>
  </request>

MyLatestImages

Use Case:

Display the latest public images of user's Camheroes account.

Examples:

Embedding an upload form on different platforms.

Embedding on different web pages (such as Wordpress, etc.).

Foreign Words:

none

Requirements:

Requirement is an existing Camheroes account and uploaded pictures.

Architecture:

REST (Wikipedia link)

The request should exclusively done via REST. GET as procedure is advisable.

HTTP Procedure

GET

LIMIT

Maximum limit are 25 pictures currently.

Authentication

User name and password seperated by a colon are needed for authentication, the password has to be SHA1 encrypted. Furthermore these specifications have to be coded in base64.

Example:

http://www.camheroes.com/api/myLatestImages?lparam=GVjM2FiNDQ2ZjN&limit=5

Error Message:

If there occur an error during the request you'll get a XML response with status 0.

Example:

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>0</status>
  </request>

Server Response (successful):

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>1</status>
  </request>
  <images>
    <image>
      <thumbnail>http://user.camheroes.com/uplo..</thumbnail>
      <smallimage>http://user.camheroes.de/uplo..</smallimage>
      <originalimage>http://user.camheroes.de/uplo..</originalimage>
      <imagelink>http://user.camheroes.com/picture/587</imagelink>
      <uploadtime>2009-01-17 12:01:09</uploadtime>
      <uploadmode>iPhone</uploadmode>
      <timezone>Europe/Berlin</timezone>
      <description>My friend and I in our holidays</description>
      <comments>
        <comment>
          <user>floeH</user>
          <message>This picture is sweet</message>
          <time>2009-01-17 14:01:09</time>
          <timezone>Europe/Berlin<timezone>
        </comment>
        <comment>
          <user>exrevel</user>
          <message>Where have you been?</message>
          <time>2009-01-17 13:25:50</time>
          <timezone>Europe/Berlin<timezone>
        </comment>
      </comments>
    </image>
    <image>
      <thumbnail>http://user.camheroes.com/uplo..</thumbnail>
      <smallimage>http://user.camheroes.de/uplo..</smallimage>
      <originalimage>http://user.camheroes.de/uplo..</originalimage>
      <imagelink>http://user.camheroes.com/picture/587</imagelink>
      <uploadtime>2009-01-16 12:01:09</uploadtime>
      <uploadmode>iPhone</uploadmode>
      <timezone>Europe/Berlin</timezone>
      <description>My dog and I</description>
      <comments>
      </comments>
    </image>
  </images>

Server Response (incorrect):

<?xml version="1.0" encoding="utf-8" ?>
  <request>
    <status>0</status>
  </request>