API¶
Introduction¶
Integrating with the NEXTSTEP platform requires only a few simple API calls.
- Document Intake: Submitting new documents by making a request to the platform
- Document Return: Receiving or retrieving completed documents and metadata
The APIs that you leverage will depend on the nature and requirements of your integration.
All public APIs exposed by the NEXTSTEP use Representational State Transfer (REST) architecture. API documentation presented here is platform and language agnostic and described simply as its HTTP request or response components.
For tutorials demonstrating how to integrate with NEXTSTEP using a particular platform or programming language refer to Getting Started.
Document Intake¶
Document Intake is the process by which new documents are submitted to the platform. Intake supports submission of documents in the following formats:
- Tagged Image File Format (TIFF)
- Joint Photographic Experts Group Format (JPEG)
- Portable Network Graphics Format (PNG)
- Portable Document Format (PDF)
When submitting documents to the platform, callers will select an appropriate API endpoint based on the type of system that produced the incoming document, or that accepts the set of incoming metadata that best describes the document.
| Endpoint | Description |
|---|---|
| Fax Notify | Accepts new documents with fax-centric metadata |
| Generic | Accepts new documents with generic key-value pair metadata |
Document Return¶
Following completion of document processing the image and metadata files for the document are ready to be returned. Files are returned to the original calling application or system in one of the following ways:
| Method | Description |
|---|---|
| Delivery by HTTP PUSH | Receiving files by accepting a request from the platform |
| Retrieval by HTTP PULL | Retrieving files by making a request to the platform |