Content requests
Content requests are chunks of content that can be handled by Contentor, either by localizing them or creating new content based on instructions provided in the request. Our APIs and integrations all use content requests when they send or retrieve content.
Content requests represent blocks of content that Contentor can manage, either through localization or by generating new content based on provided instructions. All of our APIs and integrations rely on content requests for sending or retrieving content.
Languages
Languages play a vital role in content requests, providing information about the source and target language. The source language is used for context and original content, while the target language specifies the desired language for fulfillment.
For elements like hints, field names, and certain context fields, you can provide them in the source language, target language, or in English.
Both source and target languages should follow the BCP 47 specification to ensure proper regional variations, for example: sv-SE, da-DK, en-US, en-GB
State
Each content request has an associated state, indicating its progress. A request begins as pending when received but not yet processed. Once confirmed, Contentor has reviewed and acknowledged the request, and fulfillment is imminent.
Completed requests have been fulfilled, with all fields updated to reflect the final content.
Content request may also enter a failed state, which typically occurs due to faulty HTML in a
field of type "type": "html".
The state of a content request can change between any states, so it's possible for a request to be completed without being confirmed or for a request to transition from completed to confirmed.
Fields
The content within a content request is organized as fields. Fields are dynamic and can vary from request to request.
Fields are always categorized by type, whether they contain context, localizable values, or values to be created. Including context, such as the URL and product category, is recommended in requests. The article on Context provides more details on providing effective context.
The order of fields within a content request impacts the fulfillment process. Organizing context fields before localizable and creatable fields makes the process more efficient for Contentor in fulfilling your requests.
While fields can be fully dynamic, it's advisable to maintain a similar field structure for similar content when building a custom integration. Consistency makes it easier for Contentor to work on the requests as employees will learn the structure and know what to expect when new requests arrive.