API Documentation

The greatcontent API enables programmatic access to a majority of greatcontent services. Our API can be used by clients and partners in order to optimise internal processes. 

Accessing the API

Credentials and Sandbox

Please contact your project manager to receive access tokens to our API as well as access to our sandbox environment.

General information

The greatcontent API is accessible through the REST API interface using standard HTTP(-s) protocol. Content-type for both Request and Response is application/json. Request parameters and results must be UTF-8 encoded.

Authentication

You need an authentication token to make a request, which will be shown in your user account once logged in. We use Oauth2 token-based authentication method. Please ensure that you keep the token confidential. Authentication token must be sent in the HTTP request Header: Authorisation : Bearer SOME_TOKEN_STRING

Error handling

Errors are indicated by standard HTTP error codes. It is important to make sure that your application handles errors in an appropriate way. The following error codes are used:

  • 400 Bad request. Please check the error message and your parameters.
  • 401 Authentication failure. Token is expired/not valid.
  • 403 Operation not allowed
  • 404 Resource not found
  • 422 Unprocessable entity. Logical issues arised (not enough balance, wrong order transition, etc)
  • 500 Internal error (Technical problem on our side. No error message sent to client)
  • 503 Resource currently unavailable. Try again later.

Definitions

  • Project: Entity that is used to store global settings for one or more orders which are created within that project as well as the wapping entity for 1-n orders.
  • Order: Entity which is moved through the order handling process and is used to manage the text production process between clients, greatcontent and contractors.
  • Order Types: Order types defined the contractor assignment for the copywriting and / or proofreading. The following types exist:
    • Open Order (OO) → Any eligible contractor can take it.
    • Group Order (GO) → Only contractors from a group can take it. Group order required the creation of a copywriter or proofreader group. beforehand.
    • Direct Order (DO) → Only one specific contractor can take it. Direct orders require the contractor to be bookmarked by the client.
  • Quality Levels: Quality levels are used to categorise our contractors according to their skillset, reliability, and quality of work. Each contractor has one of the following quality levels assigned: 4 (basic), 4+, 5, 5+, 6, 6+ (very advanced). Orders are created with a corresponding quality level in order to match them.
  • Language: Language in which texts can be ordered.
  • Keywords: Keywords are specific terms that can be placed in a defined density (relative or absolute) within a text. Orders with defined keywords can only be submitted if the required keywords are placed in the required density. 
  • Stopwords: Stopwords provide flexibility to contractors when using the required keywords by allowing the placement of defined terms before of in between the keyword. Example: If you would like “flights China” to be the main keywords of the text, by selecting this option you are allowing the writers to rephrase the keywords as follows: “flights to China” or “flights in China”, using the stopwords “in” and “to”. Search engines have recognised the use of stopwords and they are vital in allowing easy use of keywords in your text.
  • Flexendings: Flexendings provide a certain level of flexibility to contractors when using the required keywords, by allowing the extension of a keyword by up to three letters.
    • Example of supported keywords with flexendings: a) house → house(s), b) door system → door system(s)
    • Example of not supported keywords, as it is not allowed to change or delete letters of defined keywords: a) Haus → Häuser, b) gelb Haus → gelbes Haus
  • Plagiarism check: The plagiarism check ensures that the submitted text is unique and does not include any stolen text fragments from previously submitted texts or from the web.
  • Processing time: Number of days that are given to the contractor to work on an order.
  • Briefing: The briefing includes all written instructions e.g. audience, brand guidelines, tasks, etc. which are relevant for the contractor to write a text.
  • Layout: The layout defines the text structure and formatting requirements (especially HTML formatting) which the contractor needs to apply to the text. If a layout is defined an order can only be submitted if the text structure is valid.
  • Text topics: Topic of a text which helps to categorise and identify the text.
  • Text types: Type of a text which helps to categorise and identify the text.

Endpoints