REST API
Doc Gen offers both webhooks and a REST API for integrating with other systems. Authentication is OAuth 2.0, with mTLS available on top if you need it. Keys are managed at customer level, so storing and protecting them is your side of the arrangement.
The REST API is also available from inside Workflow when the built-in actions are not enough.
Every host on this page follows the environment you pick here. The choice sticks as you move between pages.
Available APIs
| Solution | Reference |
|---|---|
| Smartforms (Studio) | https://smartforms.metaforce.net/documentation-api |
| Digital Signing | https://digitalsigning.metaforce.net/documentation-api |
| Archive | https://archive.metaforce.net/documentation-api |
| Pages v3 (webeditor) | https://webeditor.metaforce.net/documentation-api |
| Pages v4 (webeditor-v4) | https://webeditor-v4.metaforce.net/documentation-api |
| ViewPoint | https://viewpoint.metaforce.net/documentation-api. ViewPoint’s API is the backend of the ViewPoint application, so this reference is short and most calls are not listed. |
| Audit | No public reference page. The call that posts events is described in Audit API. |
The reference pages above list the public calls of each API. The pages in this section explain how to use them, with examples:
| Solution | Guide |
|---|---|
| Smartforms | Create a Smartform, PDF, Read and delete forms |
| Text Library | Text Library API |
| Digital Signing | Digital Signing API |
| Archive | Archive API |
| Pages | Create documents, PDF and other outputs, Distribute and archive, Store and find documents |
| Audit | Audit API |
| Statistics | Statistics API |
Which client do I need
Every call needs a bearer token from an API client. The client type decides which APIs the token reaches:
| Client type | Use it for |
|---|---|
| Standard | Smartforms, Text Library and Pages. |
| External System | Third party systems such as Salesforce, with a limited scope. |
| Audit | Posting audit events, see Audit API. |
| MetaTool | Creating MetaTool documents. |
The scope names and the steps to create a client are in Authentication.
Environment in the URL
Some APIs take the environment as part of the path, so one host serves Development, Test and Production versions of your content.
| API | Where the environment goes | Values |
|---|---|---|
| Smartforms | /{environment}/Integrations/..., or the environment field in the request body | Development, Test, PreProduction, Production, in any case |
| Archive | An optional segment after the name: /Archive/{environment}/..., or the x-centerpoint-environment header, which wins when both are sent | Development, Test, PreProduction, Production, with exactly this case |
| Pages | /{customerEnvironment}/..., always | Development, Test, Test1 to Test5, IntegrationTest, AcceptanceTest, Production |
Each guide page says which calls accept the environment.