With many data integration platforms, APIs are simply an add-on. With Scribe Online, this couldn’t be further from the truth. The API is a full-blown endpoint, which is also used by the Scribe UI itself. Scribe provides users with unprecedented levels of control so that users can adjust and add to the platform as they see fit. The API even allows users to add features not shipped with the platform. When you realize everything the API permits you to do, it is an eye-opener, opening up a lot of different opportunities and providing you with great flexibility.
You could build your own UI to handle any kind of Scribe Online action on a native smart-phone app, or – as I will demonstrate below – just want to make life easier with automation.
If you have to handle the same task more than once and you don’t want to click and wait for the UI, then developing automation capabilities is key. Automation allows you to bypass manual processes that quickly become tedious and ultimately, waste time. By enabling automation where possible, you will allow your business to be more effective and save time. Ultimately, the time you save through automation can be used to solve more problems and keep your customers happy.
Here I will show you how to send the work-package as REST-requests to Scribe Online via the API.
To be able to access the Scribe API from your organization, you need to allow the IP-address or the range to access the organization. To accomplish that, go to the Scribe Online UI and navigate over the More menu into the Security settings.
Create a new rule and define the IP Address or the range. Make sure the API Access button is checked.
Later we will also need the Organization ID, which you can find on the Organization Information Tab.
You have two options to play around with the API. If you just want to test, you can navigate to https://dev.scribesoft.com/ and see all available operations. You can also test them live in the page, if you entered your Scribe credentials.
But if you really want to automate your processes you can download Postman. This is an app running on the Chrome browser.
Manipulate Maps of a Single Solution
Setting up Postman to connect with Scribe Online is a snap. In Postman on the left side you can create a new Collection to arrange your Scribe Calls together.
We will cover the following steps:
- Get the ID of your solution
- Prepare the selected solution
- Verify the result (is it done).
Create a new Collection named “Scribe – Prepare all Maps of a solution”.
With our first call we want to get all Solutions from Scribe to query the solution ID we need. Open a new tab in the builder section. Create a GET call for the solution. You can copy the proper URL from the DEV-website. Of course, we need to put in the right organization ID.
In Postman you are also able to work with Share Variables, which you can find under the small tool-icon in the upper right. I created a variable for the organization ID, since this is frequently required.
On the Authorization-Tab you need to choose “Basic Auth” and provide your credentials for Scribe and click “Update Request”.
Now it should look somehow like this:
If you click “Send” you will get the result as JSON in the lower part of the screen.
Now you just need to find the Id for the Solution you want to manipulate and store it into another Shared variable.
“name”: “Demo – Solution”,
From now on it is always the same:
- Find out the right call by examine the DEV-Website.
- Setup the Query.
- Don’t forget the Authentication.
- Save the Query and assign it to the proper Postman project.
The additional needed calls for preparing the maps are:
The Post call will respond with a preparation Id. You can use the Id to check for the current completion status via:
With the Scribe’s data integration API, it is possible to automate repeating actions by simple calls. There is not much more needed beside your credentials and the exception rule for your IP address. With the time you save through automation you’ll be able to do more business with your customers and, critically, do it more quickly and efficiently.
So, feel free to be creative and simplify your daily Scribe life as much as you like!
This post was contributed by Lars Müller, Senior Application Consultant with CRM Partners AG, and a Scribe Software MVP.