Inforama API Guide

Inforama has powerful APIs that allow integration with other systems



The following services allow integration of Inforama projects with other systems such as CRM or document management. In order to use the Soap Service you will need to pass your username and API key as part of each service call. You can find your API key under the account settings of the studio at https://www.inforama.com/studio/account/api-key.php.



The ProjectManager Service


The Inforama ProjectManager WSDL can be found at...

https://www.inforama.com/services/ProjectManager?wsdl


The ProjectManager service exposes the following methods...



The DocumentGenerator Service


The Inforama DocumentGenerator WSDL can be found at...

https://www.inforama.com/services/DocumentGenerator?wsdl


The DocumentGenerator service exposes the following methods...




ProjectManager Service Functions

listProjects

The listProjects function returns a list of projects that have been defined in the Inforama Studio for the user passed in the authentication headers. The function returns an array of ProjectStub objects.


Request Parameters
Name Type Description

Returns
Type Description
ProjectStub List List of ProjectStub objects. The project name is a property of the ProjectStub object.


getProjectOutline

The getProjectOutline function retrieves details of a specified project. These details include a list of all artifacts contained in the project and associated modification information.


Request Parameters
Name Type Description
projectName String The name of the project whose details should be returned.

Returns
Type Description
ProjectStub Project templates and Datasets are stored in Lists within the ProjectStub object.


retrieveArtifactFile

The retrieveArtifactFile function retrieves details of a specified project. These details include a list of all artifacts contained in the project and associated modification information.


Request Parameters
Name Type Description
projectName String The name of the project containing the template.
templateName String The name of the template whose details should be returned.
templateType String The type of template whose details should be returned.

Returns
Type Description
BasicFileHandler This object contains a byte array containing the template file.


listProjectDataSets

The listProjectDataSets function retrieves a list of datasets for the specified project.


Request Parameters
Name Type Description
projectName String The name of the project containing the datasets to be returned.

Returns
Type Description
DataSets This object contains a list of DataSet objects.





DocumentGenerator Service Functions

callBatchRequest

The callBatchRequest function returns a list of projects that have been defined in the Inforama Studio for the user passed in the authentication headers. The function returns an array of ProjectStub objects.


Request Parameters
Name Type Description
dataRequest InlineDataRequest Information about the request to be processed.

Returns
Type Description
InlineDataResponse ProjectStub list. The project name is a property of the ProjectStub object.




Request Objects

ProjectStub

Field Type Description
name String The name of the project containing the template to be generated
createDate Date The date the project was created.
modifyDate Date The date the project was last modified.
templates TemplateStub List List of project Templates
dataSources DataSource List List of project Datasources
dataSets DataSet List List of project Datasets


TemplateStub

Field Type Description
type String The type of this template
name String The name of the template
createDate Date The date the template was created.
modifyDate Date The date the template was last modified.


DataSets

Field Type Description
type DataSet list A list of project DataSet objects


DataSet

Field Type Description
type String The type of this dataset
name String The name of the dataset
createDate Date The date the dataset was created.
modifyDate Date The date the dataset was last modified.


InlineDataRequest

Field Type Description
projectName String The name of the project containing the template to be generated
source String Should be set to the literal string 'API'
docName String The name of the template (PDF, letter, pack) to be generated.
docType String The type of document to be generated. Valid values are PDF, OOLETTER, PACK.
datasetName String The name of the Dataset that is used to create the document
uploadedDocHandler FileHandler The Dataset payload used to generate the templates
returnType String How to return the generated documents. Valid values are PDF and ZIP.
outputFormat String If applicable, will convert resulting document to the specified format. Valid values are ODT and PDF.
actions String Array An String array of actions to be carried out on the resulting documents. Valid values are return and email.