Scribe SDK Overview
Scribe has developed a universal method to allow most APIs to talk in a common protocol. Our SDK contains several tools that make it easy to implement a connection to virtually any API. Once a “Connector” is available, business users can leverage our simple but powerful visual “drag and drop” design environment to create and manage complex custom solutions without coding.
Scribe provides additional features to end users to manage the entire integration life-cycle including: provisioning, deploying, managing configuration, and monitoring executions as a complete end-to-end integration solution.
Getting Started Options
The Scribe Marketplace has extensive library of Connectors, provided both by Scribe and third-parties, to a large number of commonly used applications such as Salesforce, Oracle, and Microsoft Dynamics 365. If you don’t find a Connector in our marketplace to solve your integration problem, we provide you with a set of tools to build your own.
There are two options provided in the SDK to get you started on your Connector development projects, the Fast Connector Framework (FCF) and the Connector Development Kit (CDK).
The Fast Connector Framework is a light weight development kit designed to allow a developer or Business Analyst with limited knowledge of Scribe Online to create a basic Connector in hours instead of days. Inside the FCF there are two frameworks available:
- Integration Framework — Build a basic Connector that uses JSON or XML to communicate with the external APIs of your applications and underlying datastores. Use this simple Connector to easily query or perform operations on an external system from Scribe Online.
- Messaging Framework — Setup a Connector that parses inbound messages, also known as Webhooks, to Scribe Online from an external system.
The other more complex option for creating a Connector is our Connector Development Kit (CDK), which supports implementing Connections to almost any API.
Technical business users are able to use the FCF to deploy simple Connectors. For more complex integration needs, a developer can use the CDK. Refer to the limitations of the FCF to determine the best path for your organization. See Fast Connector Framework (FCF).
Scribe recommends that anyone trying to leverage the CDK be competent in .NET development and have a thorough understanding of the application API or technology to which you are connecting via Scribe Online. Developers will also benefit from ancillary skills with web services, relational databases, and testing.
Additional skills should include general API / SDK development experience using C#, or Visual Basic; and supporting tools. All sample code and examples are written in C#.
Developers do not require previous experience with Scribe Online technologies, architecture, or internal data structures.
To develop a Scribe Online Connector with the CDK, requires the following development environment:
- Microsoft Visual Studio 2010 or later
- Microsoft .Net 4.5.2
Some sample project scripts included in the SDK require Microsoft SQL Server. If your site does not use Microsoft SQL Server, you can download a free copy of Microsoft SQL Server Express.
Scribe Connectors can be as feature rich as the API of the target system allows. When you are designing your Connector, there are some things you should consider in advance. See Connector Design Considerations for a detailed list.
Scribe Online Developer Programs
To create a Connector that is available to users outside of your Organization, contact us at ISV@scribesoft.com.
Scribe Online Community
In the Scribe Success Community, you can access a Knowledge Base and Discussion Forums to learn and share information about Scribe Online and Scribe Online Connectors.
This document contains programming examples provided by Scribe for illustrative purposes only. Scribe grants you a nonexclusive copyright license to use all programming code examples from which you can generate similar functionality tailored to your own specific needs.
These examples have not been thoroughly tested under all conditions and are provided to you "AS IS" without any warranties of any kind. Therefore, Scribe cannot guarantee or imply reliability, serviceability, or functionality of these programs. The implied warranties of non-infringement, merchantability, and fitness for a particular purpose are expressly disclaimed.