What we do
Tools
Industries
Department
How we workLet's talk →
Home/iManage/Getting Into the iManage API on Cloud or On-Prem
iManage Work

How to Get iManage API Credentials, and What to Build Once You Have Them

You've been asked to connect something to iManage Work: matter intake, Salesforce, a signing flow, a tool the firm built itself. The current API is iManage's REST API v2, also known as the iManage Universal API. The first job isn't code. It's credentials, and how you get them depends on whether the firm is on iManage Cloud or its own servers.

iManage API, the short version

Which API: REST API v2. The v1 REST API, the COM SDK and the old WorkSite Web SOAP API are all past end of life.

Docs: on iManage's help center, behind a customer or partner login. An on-premises server licensed for the API can also serve documentation for its own version.

Auth: OAuth 2.0. Your application is issued a client ID and secret, and users or a service account sign in through iManage.

Cloud or on-prem: on iManage Cloud, the application is registered with iManage. On your own servers, an administrator adds it in Control Center.

iManage's ready-made integrations next to what the API is for

Prebuilt

The general case, already built

  • Salesforce: links an iManage workspace to its matching Salesforce record.
  • DocuSign: sends a document from iManage for signature and files the executed copy back.
  • SharePoint and Office 365: lets people work on iManage documents from inside Microsoft's apps.
Built on REST v2

The firm's own rules

  • A workspace created from a new matter with your metadata, template and security defaults.
  • An executed document that opens a billing entry or a task in practice management.
  • Profile fields brought back in line with the matter record when a matter is renamed, reassigned or closed.
  • An in-house tool that searches or files into iManage without staff leaving it.

If a prebuilt connector covers the job, use it. The API is worth the build where the firm's own conventions decide what should happen next.

Getting a first iManage API call working

  1. 1

    Confirm where the firm's iManage runs

    iManage Cloud and an on-premises Work server register applications differently, and an on-prem server has to be on a release that supports REST v2. Ask IT which you're dealing with before anything else.

  2. 2

    Check the API is licensed and switched on

    On premises, API access comes with the server's license. On iManage Cloud, the API has to be enabled for the firm's tenant. Without it, nothing below works however well the application is set up.

  3. 3

    Register the application

    On iManage Cloud, a firm or vendor that isn't an iManage technology partner requests an OAuth application from iManage and receives a client ID and secret. On premises, the developer supplies the application's details, including its OAuth settings and redirect URI, and the firm's Control Center administrator adds it.

    Watch for: client secrets can expire. When one does, new sign-ins fail, so note the date and plan the rotation.

  4. 4

    Decide whose identity the integration uses

    A tool lawyers use signs each of them in, so it sees only what they can. A background job, such as workspace creation from new matters, runs as a service account, and that account's access sets what it can read and change.

  5. 5

    Make the first read

    Start with something harmless, like the libraries the account can see or one workspace you know, and check the profile fields come back the way your firm fills them. Custom fields are where firms differ most.

Settle these before writing against iManage Work

  • Which matter-numbering and profile fields does the firm rely on?

    Custom fields carry client, matter, practice area and more, and every firm fills them in its own way. The integration has to write them the way records and search expect.

  • Who owns the workspace template and default security?

    A workspace made by code should look like one the records team built. Agree which template and which access defaults apply to each practice group.

  • Is the firm moving to iManage Cloud?

    Cloud changes sign-in and how applications get registered. Building against where the firm is heading saves doing the auth work twice.

  • What happens when the API refuses a write?

    A missing matter or a permissions error shouldn't disappear. Send it to a queue the records team works from, with the reason attached.

  • Which older scripts still call the v1 API or the COM SDK?

    Both are past end of life. Move those scripts to REST v2 before the next server upgrade rather than after it.

iManage API and connector questions

Does iManage integrate with Salesforce out of the box?

There's an integration that links an iManage workspace to its Salesforce record, and it handles that general link. Firm-specific field mapping, or creating the workspace with the right profile the moment an opportunity closes, is custom work on the API. n-frames builds that layer for firms that need it.

Does iManage integrate with DocuSign for signing documents?

Yes. A document can go from iManage into DocuSign and come back filed as executed. What should follow, a billing entry, a task, a note on the matter, is the firm's call, and it's where an API build begins.

Can iManage work with SharePoint or Office 365?

Yes. iManage's Microsoft integrations let people open and save iManage documents from Office apps and work with them alongside SharePoint, without a separate iManage window for each edit.

Is there iManage API documentation available to developers?

Yes, on iManage's help center, though it needs a customer or partner login. A firm running its own server with an API license may also find docs for that exact version on the server, which helps when cloud and on-prem behavior differ.

What is the iManage SDK?

Historically, the COM-based Work SDK that desktop tools and scripts were built on. It's past end of life now, so new integrations are written against REST API v2. iManage gives technology partners development resources through its partner program.

Let's talk

Tell us the one thing your team does manually that eats up time. We read every message and reply within a day.