They are answered by the XTRF community and our experts


Vendor Portal API

Sancho Leath 6 years ago in API updated by Jussi Rautio 6 years ago 2

Question for all you API users. Based on API commands are not yet available for the Vendor Portal. Have you found any workarounds (scripted jobs, etc.) to pull data from the Vendor Portal?

Example: We would like to access the memoQ Handoff Package in the Home Portal. Currently it is only available on the Vendor Portal. Until XTRF makes that data package available in HP, we would have to use some automated workaround to give our PMs a break.

This is the end game we have in mind:

Create a Scripted Job in XTRF with the following actions as each T or R1 job is started:

- download and copy memoQ Handoff package from VP to corresponding HP project

- unzip this package and add contents of ProjectTM and ProjectTB subfolders to the started job as Reference Files

This way, we can finally have a workaround for all those vendors who do not use memoQ and rely on Project TM (.tmx) and TB (.csv) as additional reference material for the job. To make it more sophisticated the Scripted Job can be conditional based on the CAT tool entry in the vendor profile.


Sending commands through the API

Dennis Rosenbaum 6 years ago in API 0


I would like to know whether it is possible to execute Commands so that I can edit SMART projects the same way the XTRF code base does.

The javadocs don't cover all the Commands, neither does the API. As I do understand it would be a lot of work to make all the Commands available as a specific implementation. But it would be of real great use to execute a Generic Command.
Maybe for a command like this:


Executing the command as an API call like so: {apiUrl}/commands/{command-name}?arg[0]={argument0}&arg[1]={argument1}
So for this specific example: {apiUrl}/commands/MarkQuoteAsSentCommand?arg[0]=INIBY7QGPJBJLPF5MFJXRRKHCA

This way you don't need to provide full documentation nor creating a whole new interface layer for all commands. We could just look up the commands within the logs and execute them in this generic way.

Kind regards,

Dennis Rosenbaum


Please share an experience of the use of API

Svitlana (Proftranslation LSP) 6 years ago in API updated by Dennis Rosenbaum 6 years ago 20

Anyone use the access to API?
If so, could you please share an experience? For what purpose, what have you achieved with it, etc.?


Where is the full API documentation?

Anonymous 1 year ago in API updated 1 year ago 6

For example, The documentation at ``https://----xtrf--u/api-doc#/home-api`` is lacking filtering parameters like `q.startDate=12345668008` on smart views endpoints like `/browser`. Is there a full api guide?


Google sheets add-on

felicia 2 years ago in API updated by Thijs Senten 2 years ago 16


What happened with the sheets add-on? That was an amazing tool.


New in XTRF and Groovy

Jorge Vallejo 3 months ago in API updated 3 months ago 2


I am completely new to using XTRF and its API. I'm looking for a tutorial on how to create custom columns or personalize them for Smart Projects. Is this possible, or is custom coding only applicable to Classic Projects?

Thank you.


Classic Projects: Add Client PO Number in "Create Classic Project" endpoint

Juan (Comunica Translations) 5 months ago in API 0


I can see that when adding a task to a project, there is a field for the Task PO Number: 


That's for the endPoint: /projects/{projectId}/tasks

But isn't there a way to insert the Client's PO Number in the project scope?
[POST] projects/ doesn't have a filed for it.

Thanks for you help.


How are xtrf APIs managed?

Karl 1 year ago in API updated by Thomas Lespes 1 year ago 4

I'm curious how xtrf determines what does and does not get included in the APIs.

This is sort of of a loaded question since I've recently ran into a couple of missing items that I was/am totally baffled as to why they aren't available.

One is the inability to get meta information about custom fields. Maybe I'm unique in wanting to use the API in this manner, but when constructing front end tools to interface with xtrf, needing, e.g., information about the options from a select control, or data type from an input, etc., for having the ability to dynamically and confidently render a web application that matches what is actually in xtrf would seem very fundamental. But this is missing entirely. Why?

Today while working from a spec that is requesting a web application to frontend our custom client creation process, one of the fields that was requested to set was the "Individual" option in the standard client data, and is in fact one the few options provided in the xtrf's own "add client" dialog in ui. There is no API support to be able to manipulate this option, so we pulled it and now have to instruct users to go set this field manually if they need this post create, not a great experience.

These are just two recent items, but my question, why is there this disconnect between how the xtrf platform works from the UI vs what's available through the API? It would seem obvious to me that if an option is made available through the UI, it should be added to the API as well as part of the same release version of the xtrf platform.

Am I unique here for how I want to use the xtrf API? I would certainly hope not.

It's as if there's a disconnect between the left and right hands here.


Customer invoice payment status information through API

Thijs Senten 3 years ago in API 0

It seems the both the /accounting/customers/invoices & /accounting/customers/invoices/{invoiceId} API endpoints do not return a field with the invoice's payment status. The samen endpoints for provider invoices actually do.

Was this left out intentionally? And would it be possible to include this information in the response?

I know it's probably possible to get this information through a macro, but it's so much easier and cleaner if it could be included in the response, just like with the provider invoices.


OCR program connected to XTRF via API

Monika 5 years ago in API updated by Bartosz Budzyński 5 years ago 9

Hello, I wanted to ask if anyone was already thinking about connecting any OCR tool to XTRF via API? So it could work as an automatic action, and import for example a PDF and export editable format, like Word or HTML, etc?

I would be very grateful for any tips.