editorr API Documentation

Welcome to editorr’s API! You can use this API to access all our API endpoints.

Getting Started

How to connect to API

This is how you connect to the API

Generate an API KEY under your account settings.

Authentication

Authentication is done via your API KEY.

Contact

Suggestions, contact, support and error reporting on support@editorr.com

ConnectUser

ConnectUser - Authenticate User to Portal

/ConnectUser
curl -i http://editorr.com/api/editorr-job-api.php/ConnectUser

Parameter

Field Type Description
apikey String

This will be unique apikey for each user.

Success 200

Field Type Description
userDetail Array

This array contains all the information of a User.

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

{"userDetail":{"paypal":"","user_id":"235","user_level":"a:1:{i:0;s:1:\"3\";}","restricted":"0","account_active":"1","username":"brian@socialtect.com","name":"dumy user","first_name":"dummy","email":"dummy@mail.com","password":"123@bc2f@#","free_words":"-207","level_points":"105500","notifications":"0","timestamp":"2016-07-08 14:17:51","referralCode":"sdfsd","api_key":"34csdf4","mobilePhone":"","phone_verified":"1","verification_code":null,"notifySms":"a:4:{s:3:\"new\";s:1:\"0\";s:6:\"picked\";s:1:\"0\";s:5:\"fixed\";s:1:\"0\";s:4:\"chat\";s:1:\"0\";}","notifyEmail":"a:6:{s:3:\"new\";s:1:\"1\";s:6:\"picked\";s:1:\"1\";s:5:\"fixed\";s:1:\"1\";s:4:\"chat\";s:1:\"1\";s:5:\"clean\";s:1:\"1\";s:6:\"markup\";s:1:\"1\";}","referrer_id":null,"referrer_initial_credit":null,"fb_token":null,"creditcard_id":null,"business_id":"2","editor_monthly":null,"editor_lastpayment":null,"free_trial":"1","only_free_jobs_email":"0","not_verified_email":"0","inactivate_on":null,"ontraport_id":"","admin_notes":null,"getdrip_updated":"0","modified_on":null}}
Contact Demo

MyJobs

MyJobs - Get all jobs of a user.

The purpose of this function is to get all jobs of a User.

/MyJobs/:apikey
curl -i http://editorr.com/api/editorr-job-api.php/MyJobs/uhuguuggus

Parameter

Field Type Description
apikey String

This is unique key for each user.

Success 200

Field Type Description
jobs Array

This is the array of all user jobs

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

{"jobs":"[{"id":"1","name":"Jxhshhshs","originalText":"Sample Text","originalNotes":"","originalTextLength":"4","fixedText":"","fixedTextNoMarkup":"","fixedTextComments":null,"price":"0.08","editor_price":"1.00","idOfRequestor":"5","idOfLastAssignedEditor":"7","editor_chosen":"0","status":"11","ref_id":"78eKju","job_category":"1","ratingOriginal":"0","ratingFixedQuality":"0","ratingFixedTimeliness":"0","promisedTime":"10","rating_FleschReadingEase":"97.00","rating_ColemanLiau":"38.60","rating_FleschGradeLevel":"0.00","rating_AutomatedReadability":"24.10","smart_queue":"0.00","readability_before":"0","readability_after":"0","readability_change":"0","category":"","tags":"","created_at":"2016-07-26 05:31:12","submitted_at":"2016-07-26 05:31:12","updated_at":"2016-09-28 12:38:54","taken_at":"2016-07-28 09:38:20","fixed_at":"2016-07-29 01:41:48","redone_at":null,"pay_status":"4","editor_paid":"0","editor_notes":"asass","user_rating":null},{"id":"1","name":"Jxhshhshs","originalText":"Sample Text2","originalNotes":"","originalTextLength":"4","fixedText":"","fixedTextNoMarkup":"","fixedTextComments":null,"price":"0.08","editor_price":"1.00","idOfRequestor":"5","idOfLastAssignedEditor":"7","editor_chosen":"0","status":"11","ref_id":"78eKju","job_category":"1","ratingOriginal":"0","ratingFixedQuality":"0","ratingFixedTimeliness":"0","promisedTime":"10","rating_FleschReadingEase":"97.00","rating_ColemanLiau":"38.60","rating_FleschGradeLevel":"0.00","rating_AutomatedReadability":"24.10","smart_queue":"0.00","readability_before":"0","readability_after":"0","readability_change":"0","category":"","tags":"","created_at":"2016-07-26 05:31:12","submitted_at":"2016-07-26 05:31:12","updated_at":"2016-09-28 12:38:54","taken_at":"2016-07-28 09:38:20","fixed_at":"2016-07-29 01:41:48","redone_at":null,"pay_status":"4","editor_paid":"0","editor_notes":"asass","user_rating":null}...]"}
MyJobs Demo

CreateJob

CreateJob - Create a new Job

The purpose of this function is to create a new job.

/CreateJob/:apikey?title=Sample+Job&desc=Sample+description+Submiited
curl -i http://editorr.com/api/editorr-job-api.php/CreateJob/uhuguuggus?title=Sample+Job&desc=Sample+description+has+submitted

Parameter

Field Type Description
apikey String

This is unique key for each user.

title String

This is the title of Job.

desc String

This is the description of Job.

Success 200

Field Type Description
success String

This will be success stirng.

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

emptyTitle

Title is empty.

emptyDescription

Description is empty.

connectionIssue

When there is Database or Internet connection issue.

{"success":"Posting has submitted successfully."}
CreateJob Demo

JobStatus

JobStatus - Read status of a Job

The purpose of this function is to get the current status of a job.

The statuses are:

draft
submited
editing
reediting
rejected
fixed
closed

/JobStatus/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/JobStatus/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
Status Integer

This is the staus of Job

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"Status":"fixed"}
Job Status Demo

JobStatus

Editor - Get the Editor who is editing the job

The purpose of this function is to get the id of the editor id of a job.

/Editor/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/Editor/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
name String

This is the name of editor

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"name":"brian"}
Editor Demo

ChatRecords - Read data for a job

The purpose of this function is to get the chat records with an editor.

/chatRecords/:apikey/:id
curl -i http://editorr.com/api/editorr-job-api.php/JobStatus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id String

The Users-ID.

Success 200

Field Type Description
id String

The Users-ID.

name Date

Fullname of the User.

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

FixedJob - Get fixed content of a Job

The purpose of this function is to get the fixed content of the job with markups.

/FixedJob/:apikey/:id

Permission:none

curl -i http://editorr.com/api/editorr-job-api.php/FixedJob/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
content String

This is the fixed content of a Job with markups.

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"content":"<\/p>This job has been created<\/span>created<\/span> to fix  wartning<\/span>warning<\/span> issue<\/div><\/p>"}
Fixed Job Demo

OriginalJob - Get original content of a job

The purpose of this function is to get the orginal content that was submitted by the user prior to being edited.

/OriginalJob/:apikey/:id

Permission:none

curl -i http://editorr.com/api/editorr-job-api.php/OriginalJob/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
content String

This is the original content of a Job.

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"content":"This job has been cresated to fix \u00a0wartning issue<\/div><\/p>"}
Original Job Demo

CleanJob - Get clean content of a Job

This function has same errors like POST /user, but errors not defined again, they were included with "apiUse"

/CleanJob/:apikey/:id

Permission:none

curl -i http://editorr.com/api/editorr-job-api.php/CleanJob/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
content String

This is the clean content of a Job without any markups.

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"content":"<\/p>This job has been cresated<\/span>created<\/span> to fix  wartning<\/span>warning<\/span> issue<\/div>
Clean Job Demo

JobNumber

JobNumber - Get the Job Number of the Job

The purpose of this function is to get the job number of the job.

/JobNumber/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/JobNumber/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
jobNumber String

This is the reference number of a job

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"jobNumber":"1OxqQp"}
Job Number Demo

UserPrice

UserPrice - Get the user price of the Job

The purpose of this function is the get the price the user paid for this job.

/UserPrice/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/UserPrice/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
price decimal

This is the price of user for job

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"price":"0.18"}
User Price Demo

TimeToFix

TimeToFix - Get the time to fix for the Job

The purpose of this function is the get the time it took to fix the job.

/timeToFix/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/timeToFix/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
name String

This is the name of editor

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

Reedit

Reedit - Get the reedited content of the Job

The purpose of this function is to get the reedited version of a job.

/reedit/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/reedit/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
name String

This is the name of editor

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

WordCount

WordCount - Get the word count of the Job

The purpose of this function is the get the word count of the job.

/WordCount/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/WordCount/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
words Integer

These are total words of job description

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"words":"9"}
Word Count Demo

PromisedTime

PromisedTime - Get the promised time for the Job

The purpose of this function is to get the promised time for this job.

/PromisedTime/:apikey/:id

Permission:admin 

curl -i http://editorr.com/api/editorr-job-api.php/PromisedTime/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

Success 200

Field Type Description
time Decimal

This is the promised time for job

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

{"data":"0"}
Promised Time Demo

RateJob

RateJob - Give rating to the Job.

The purpose of this function is to submit rating to the Job.

/RateJob/:apikey/:id
curl -i http://editorr.com/api/editorr-job-api.php/RateJob/uhuguuggus/8316

Parameter

Field Type Description
apikey String

This is unique key for each user.

id Integer

This is a Job ID.

rating Decimal

This will be rating submitted by User.

Success 200

Field Type Description
status Integer

It will be in the form of 1 or 0.

Error 4xx

Field Description
MissingApiKey

Api Key is missing.

InvalidApiKey

Api Key is Invalid.

MissingJobID

Job Id is missing.

InvalidJobId

Job Id is invalid.

MissingRating

Rating is Missing.

{"status":"1"}

Common Error Responses

Common Error Responses - List common error responses

The purpose of this section is to list common error samples for each api.


1. MissingApiKey - This error will come when no Api Key will be provided.

{"error":"MissingApiKey"}

2. InvalidApiKey - This error will come when Invalid Api Key will be entered.

{"error":"InvalidApiKey"}

3. MissingJobID - This error will come when no Job Id will be provided.

{"error":"MissingJobID"}

4. InvalidJobId - This error will come when improper Job Id will be provided.

{"error":"InvalidJobId"}