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.
Languages
Languages are an important part of content requests as they provide information about both the source and the target language. The source language is the language used when providing context, text for localization. The target language indicates the language that the request should be fulfilled in.
For things such as hints, field names and some context fields they can be provided either in the source language, target language or using English.
Both the source and target language can be specialized with extra information such as the language region to use. The region is especially useful if something is technically the same language but has regional differences, such as for English where either British or US English are commonly targeted.
State
Each content request has a certain state associated with it. The state can be used to keep track of how far along a content request is. When sent a request starts out as pending which indicates that it has been received but not yet processed. When a request switches to confirmed this means that Contentor has seen and processed the request and that it will be fulfilled soon.
Contents requests become completed when they have been fulfilled, and a completed request will have all its fields updated with the finished content. Request may be also canceled in the case where they should no longer be fulfilled.
Content requests can also have the failed state. This is usually because a
field with "type": "html" contains faulty html.
The state of a content requests can switch between any state, so its possible that something may be completed without having ever been confirmed or for a request to go from completed to confirmed.
Fields
The actual content in a content request is provided as fields. Fields are dynamic and can be different from request to request.
Fields always have a type, either they contain context, localizable values or values that should be created. It is always recommended to provide some context in requests, such as the URL and category of a product. The article Context provides more details about how to provide great context.
The order of fields within a content request is important as it affects the experience for Contentor when fulfilling a content request. Taking care to provide things such as context fields before localizable and creatable fields can make it a lot easier for Contentor to fulfill your content requests.
Even though fields are fully dynamic we recommend keeping the fields roughly the same for similar content when building a custom integration. Doing so 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.