So you want to add Pikchur to your next App? Great!
Our API mimics the ones you already integrated in the past, and all you need to do is
- Change API End point to http://api.pikchur.com/simple/upload
- Add Parameter api_key, to gain access, can be found here http://pikchur.com/api
- Optional: Add Parameter source
- Optional: Add parameter return_format values json or xml (xml is default)
Also, when you have your app, we can add you to our supported apps page! :)
You have two API options.
- 1) Upload, this is your standard method for Twitter clients, you upload to us we post to users synced accounts -except- there one used to authenticate with (in this case twitter, because you already post to it.).
- 2) Upload & Post, this method is used to post to all accounts synced to the user, including there twitter account.
Documentation
upload
This is used if the application wants to post the status message it sent for the authenticated service. For example if you use this with an authentication for “Twitter” we will not post a note to Twitter but the photo will still propagate out to the users remaining synced services (facebook, flickr, etc).
Endpoint XML: http://api.pikchur.com/simple/upload
Required Parameters:
- media
- Binary image/video data
- The image/video data to be posted.
- Binary image/video data
- username
- Text Value
- This is the username for the synced service (default is Twitter).
- Text Value
- password
- Text Value
- This is the password for the synced service (default is Twitter).
- Text Value
Username/Password OR if using Twitter’s echo oAuth system please include the following headers
- X_VERIFY_CREDENTIALS_AUTHORIZATION
- HEADER, Should contain the following
oauth_consumer_key=”YOUR KEY HERE”,
oauth_signature_method=”HMAC-SHA1”,
oauth_token=”YOUR TOKEN HERE”,
oauth_timestamp=”TIMESTAMP”,
oauth_nonce=”OAUTH NONCE”,
oauth_version=”1.0”,
oauth_signature=”SIGNATURE”
- EXAMPLE curl -v -H ‘X-Verify-Credentials-Authorization:oauth_version=”1.0”, oauth_nonce=”a436ee1ee9437e98ffafa04f39af2a69”, oauth_timestamp=”1274233993”, oauth_consumer_key=”BdkEXpkerXPqJMaiYMN3Q”, oauth_token=”16056271-aVl42OcvOA81cjdBpFy2yaLzmjLiNwSSByMXvh…”, oauth_signature_method=”HMAC-SHA1”, oauth_signature=”LiG5LqZO1Zprc6fJmVci%2FmXIwuk%3D”’ -F ‘api_key=O1kXlYN1SYQG82ZXtvZC0g’ -F ‘media=@/var/test.jpg’ -F ‘message=Hello World!’ http://api.pikchur.com/simple/upload
- api_key
- Text Value
- A Pikchur API developer key, which is used to prevent abuse. It can easily be obtained here: http://pikchur.com/api#key
- Text Value
Optional Parameters:
- message
- Media Caption
- service
- Text Value
- If the service requested for authentication is not Twitter, it can be specified by sending it along with the request. i.e: identi.ca,plurk, etc
- Text Value
- X_AUTH_SERVICE_PROVIDER
- HEADER
- The service to auth with (default is https://api.twitter.com/1/account/verify_credentials.json).
- HEADER
- source
- Text Value
- Request a source id from api[at]Pikchur.com and all photos sent in will say “Via yourApp” and link to your website.
- Text Value
- private
- Text Value
- Overrides users media privacy settings for this one upload. Options “YES” for enable privacy “NO” to make media public.
- Text Value
Sample response
<rsp status=”ok”>
<mediaid>
abc
</mediaid>
<mediaurl>
</mediaurl>
</rsp>
uploadAndPost
Used to authenticate and post a photo to the user’s Pikchur account, along with a status update to Twitter and any other supported service users have synched.
(If the service requested for authentication is not Twitter, it can be specified by sending it along with the request, such as identi.ca, plurk, etc.)
Please make sure all data sent is formatted as multipart/form-data.
Endpoint XML: http://api.pikchur.com/simple/uploadAndPost
Required Parameters:
- username
- Text Value
- This is the username for the synced service (default is Twitter).
- Text Value
- password
- Text Value
- This is the password for the synced service (default is Twitter).
- Text Value
- media
- Binary image/video data
- The image/video data to be posted.
- Binary image/video data
- api_key
- Text Value
- A Pikchur API developer key, which is used to prevent abuse. It can easily be obtained here: http://pikchur.com/api#key
- Text Value
Optional Parameters:
- message
- Media Caption / message to post to Twitter or any other service. The URL to the image will be appended to the message
- service
- Text Value
- If the service requested for authentication is not Twitter, it can be specified by sending it along with the request. i.e: identi.ca,plurk, etc
- Text Value
- source
- Text Value
- Request a source id from api[at]Pikchur.com and all photos sent in will say “Via yourApp” and link to your website.
- Text Value
- private
- Text Value
- Overrides users media privacy settings for this one upload. Options “YES” for enable privacy “NO” to make media public.
- Text Value
Sample response
<rsp status=”ok”>
<mediaid>
abc
</mediaid>
<mediaurl>
</mediaurl>
</rsp>
