Back to Paligo Academy
Welcome to this recording. We're going to talk about the API within the Paligo ecosystem, but not from a technical perspective, from a business perspective. How you can use the API in your business to make your content management process even more proficient than with Paligo and the regular user interface. We're a component content management system, as you probably know. That really means managing enterprise level content. We are various parts of UI that manage that, the authoring side. Lots of different tools for reusing content, collaborating with different parts of your organization. The translation process, making it efficient. Versioning is built into the core platform, that makes a big difference. And publishing out to different channels. As I say, we're going to talk about the API, how different parts of those can utilize the API to make life even more efficient for all the people involved in managing content. Before we jump in to looking at some API use cases that can help your organization. We've used the API ourselves. Lots of integrations, just quick examples for you. So support platform like Zendesk, Salesforce and Service Now. Content delivery platforms Fluid Topics, and Zoomin, as well as pushing to AmazonS3, Bitbucket, etc. Translation memory systems like Phrase , Crowdin, Semantix. Seach engines. Lots of different integrations: Please look at integrations to see if one already exists before you try maybe creating it yourself. So some of the cases we are going to discuss just now, regarding the API are bulk imports, synchronizing different sources within your content within Paligo. Publishing to additional channels and managing translations outside of Paligo. So as you may well know from already using Paligo, we already import all sorts of formats and on the screen I'm not going to list them all. What you can do with the API is rather than import one by one, or the whole collection of Word files, DITA files or whatever it could be, you could use the API to import them in batch to save you manually doing each one. I can save you a lot of time with the import and waiting. I think one of the most common use cases for the API is synchronizing sources. Between an external system and Paligo. For example, lets say you're a manufacturing company. You have lots of information that goes into a data sheet or technical user content. Maybe it's definitions or whatever it may be, it can change. And adding that content into Paligo manually maybe takes time. What we can do is set up a connection so all that content coming from your manufacturing database can be pushed directly into Paligo at any time. To make sure content in Paligo is always completely up to date without any manual work. Maybe you're not manufacturing, you've got a database. You've got spreadsheets. You've got content that needs to be connected and updated. The same idea. Create those connections. Make life easier and quicker for those authoring your content. And then some of the automatic content gets created without any effort from them. Maybe you've got images in external systems, such as a DAM a Digital Asset Management. So you can synchronize images from one place and make sure the same image is used in Paligo. Maybe you've got varaibles. Same type of database information that could change. Update those variables in Paligo so when you pubilsh, you're already using the latest information. Maybe you have taxonomies or ontologies.You're categorizing your content. So you want to be able to use those organizational or enterprise level taxonimies and use them also in Paligo by synchronizing those taxonomies. Very popular and interesting use cases you can start thinking about. How they can help your organization right now. I remember before we had the API, one of the most frequent requests I got was to schedule publishing. If you want to publish every night at 6 o' clock once a week at 12 o'clock on a Friday. Whatever it might be. API allows you to do that. You don't need to manually publish. You can publish on a schedlued occurance occuring when you want to do it. Automate the publishing. But, also, you know, we publish, as we showed you before, to various channels already, Zendesk, AmazonS3, etc. etc. I just chose 2 random names there. But you could also now publish with the API something we haven't set up already for you like Sharepoint. Or any other host of solutions. So take that Paligo content and push it wherever you want to push it. Using the API. Whatever you use in your whole workflow. Paligo already has a really efficient process of managing translations, as you may well know. You send XLIFF files, which are the XML files used by a translation memory system at TMS, and you import them. Then you can publish immediately. No need for any additional work. But we can automate that process. There already are translation memory systems using the API for integrating with Paligo. There are also language service providers, LSPs, that use or API for pulling content out and pushing it back in. You can also do a process called agile translations. In other words as soon as things change, the TMS can pull that content out translate it immediately and push it back in without having to wait until that whole draft is ready and pushing content out. This is becoming an increasingly popular and well used part of API, make the translations even more efficient than they are already. In reality, you won't just be using one API call and go home all done finished. You're putting a whole collection of them together. You'll have a workflow of a whole set of API calls that you'll use in order to succeed in whatever use case you want to implement. So I'm just gonna talk about a translation example. I could have chosen anyone, but let's just go through it, just give you an example of how we can use these different API aspects together. So I want to be able to pull out the latest translation content that's been put into the translation status. So yesterday I used our search API and I listed all the content in Paligo where the components, topics, have translation status. I said yesterday, could have been half an hour ago. And now I run the same API or it runs automatically and its checking if any new topics have been set for translation. They have. There are 2 topics that have been sent. So, the system will automatically now, in XLIFF, export those 2 topics to put them inside the translation management system and the translators do their majic and translate it into how many languages they need to. And then that translation is automatically imported directly back into Paligo. And as soon as it's back in Paligo, because it's ready for publication, so you can set that immediately to publish to S3 or to Zoomin, Fluid Topics, Zendesk, Salesforce, wherever you want to. So we've exported,immediately. imported the translation. All accroding to on demand. It wasn't anything the author had to do specifically, and publish that out immediately. We've put the search and the API for translations in the mix there as well as the API for publishing. On the screen you can see our API documentation. Very quickly on the left hand side, you can see the main endpoints in this document 4 folder. Translation export and import, etc, etc. In the middle we have definitions and descriptions of the APIs and on the right we have examples. So you can review these later. There will be a link on the screen there that you can click if you want to see this page and review it. You know, we really just touched a drop of what you can do with the API. There's so much you can do when you put them all together. Different use cases. But really the use cases that match what you need in your organization. Have a little think. But I think the next steps may be is, one, review that API documentation that I showed you just to give you an idea. Number two, think of any business cases where that maybe this opens up a box of potential for you with efficiencies you hadn't even thought of before. Once you've created that basic list, then maybe go into a bit more detail in the most important ones and flesh out the requirements. Once you've done that and got sign off, then you can get coding. But at any point during this process, please reach out to us. Reach out to Paligo support. We will be more than happy to think it through with you so you can make some great efficiency improvements.
