###Looking to sign up for the API? Try here

##Welcome

Welcome to the Chimp Rewriter API documentation. This is where we’ll give you everything you could possibly need to get started with the Chimp Rewriter API and integrate with us!

The Chimp Rewriter API allows developers to access Chimp Rewriter functionality from their own software. It is based around HTTP POST, making it easy to implement. With the help of this guide, you should be up and running in a few minutes. Authentication is achieved through an API Key, so there is no need to send sensitive password details over an unencrypted connection.

If you’re a developer, we’d love to hear from you to establish a profitable relationship for both of us. Check out the joint ventures page.

To be able to make API requests, Chimp Rewriter Pro users must sign up for an API Key, which is literally a one-click process on the Chimp Rewriter User Management page. After login, scroll down to the API section and click the ‘Register’ link in that box. Your new API Key, daily limits and some other info will be displayed. Too easy.

Stay Up To Date
Although we will never make any changes that would break existing connections, we strongly recommend filling out the form below, so we can keep you up to speed with any changes or improvements to the API. This includes new or improved features and usability or performance boosts.

##What the heck is an API?

Not everyone is a super nerd, so we’ll briefly explain what all the API stuff is, in simple terms.

That said, we’ll start off all nerdy. API stands for “Application Programming Interface”. In simple terms, it is a way that a software company can allow other software companies to access their service. In this case, the service is the rewriting engine of ChimpRewriter.

So, the ChimpRewriter API allows other software authors to access our rewriting engine remotely. This is completely independent of the ChimpRewriter software, so you don’t even need to have it installed for this to work! This grants the third party access to spin and rewrite text on your behalf. All you need to do is give them your account email and API key for security reasons.

The third party software will take your content, send it up to the cloud where the ChimpRewriter API will do its magic and send back the rewritten or spun version. After this, how the content gets used depends on what product you are using.

To keep it simple here’s an example of what our popular partner WP Robot would do, using it with their RSS module:

• Go to the blog or RSS feed where the original article is
• Grab all the text from the article
• Send it up to the ChimpRewriter API
• Wait for the ChimpRewriter API to send the text back (usually about 0.05 of a second)
• Post the rewritten content to your blog

Depending on your account, you get enough credits to do this hundreds of times in a day!

To sign up for the API, [click here](http://chimprewriter.com/api "Sign Up for ChimpRewriter API), or to sign up for a ChimpRewriter Pro account with included queries, click here.

##How To Call
Make a request to this URI: http://api.chimprewriter.com/MethodName, where MethodName is replaced by the method you want to call. So for a Global Spin, you would initaite a request to http://api.chimprewriter.com/GlobalSpin.

The paramaters should be appended to this to make a complete URI (do NOT add them to the post body, as that is where the article goes!). For example, a Global Spin with quality 4 and POS match 3 would be performed with this URI: http://api.chimprewriter.com/GlobalSpin?quality=4&posmatch=3.

As well as including the below paramaters, send the article or content that you want to spin as the POST body. We have a couple of examples to show you how to do this, one written in C# and one in PHP.

##Example Code
Chimp Rewriter API C# Sample Project
Chimp Rewriter API PHP Sample Functions
The SpinChimp PHP Class from our WordPress Plugin
Chimp Rewriter API Python library. Thanks to NiteoWeb (the guys behind Big Content Search)

##Return Value
Results vary from method to method, but are always returned as plain text in the HTTP response body, making no deserialization necessary. If a failure occurs, the results will look like this:

Failed: Failure Reason|Failure Reason 2

Simply check for the string ‘Failed:’ at the beginning of the response. If there are multiple failure reasons, they will be returned in a pipe (‘|’) separated string.

###Possible failure strings:
No Email specified
No API Key specified
No Application ID (aid) Specified
There are no words in your article!
Article too long (x words). Max is y.

###Each of the following are unique (only one will be returned)
Credentials check result:InvalidEmail
Credentials check result:SubscriptionExpired
Credentials check result:InvalidAPIKey
Credentials check result:NotAPIRegistered
Credentials check result:MaxQueriesReached
Credentials check result:DatabaseFailure

Example failure string: “Failed:Credentials check result:MaxQueriesReached|Article too long (6544 words). Max is 5000.”

##Limitations

Daily API requests with a standard Chimp Rewriter Pro subscription are limited to 250. If you need a high limit, we can arrange for alternative subscription models. To sort this out, contact us through the ticket system.

Each article sent to the server must be 5000 words or less. Once again, if you have a valid need for a higher limit, contact us.

##API Subscriptions

Get them here.