REST API connector for Zero Copy Connector for ERP

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 1 min. de leitura

    • Use the REST API connector to connect to any RESTful API with standardized API specification formats.

    Overview of REST API connector

    REST APIs can be used to access business data from ERP systems. Integrating these APIs has been a manual process. The REST API connector solves this by providing a reusable, low-code integration layer. Supported API specification formats are OpenAPI 3.0+, Swagger 2.0, and Postman Collections.

    Import REST API definition into the Zero Copy Connector for ERP Model Manager

    Import a REST API definition using one of the following methods:
    • Attach a Swagger/OpenAPI JSON or Swagger/OpenAPI YAML file.
    • Upload a Postman Collection (v2.1+) as an attachment.
    • Provide a public URL pointing to an OpenAPI spec file.

    The system automatically reads the specification and generates endpoint configurations, including input/output parameters, HTTP methods, and authentication schemes.

    Configure REST Service Connections

    REST connections are managed through the HTTP connection template.

    For more information, see Create an HTTP(s) connection.

    Authenticate securely

    The connector supports the following authentication options:

    • Basic Auth: A username and password (Base64-encoded). For more information, see Basic authentication credential.
    • JWT (JSON Web Token): A bearer token authentication. For more information, see JWT Bearer.
    • API Key: A key passed as a header or query parameter. For more information, see API key credentials.
    • OAuth 2.0: A token authentication with automatic token refresh. For more information, see Manage OAuth tokens.

    Credentials are stored securely in ServiceNow Vault. For more information, see ServiceNow Vault.

    The system validates that the configured credential type matches one of the authentication schemes defined in the API specification before allowing execution.

    MID Server Support

    If your REST API is hosted on-premises or behind a firewall, you can route API calls through a MID Server. The connection record includes a midServerName property that routes traffic through the designated MID Server. Cloud-hosted APIs can connect directly without a MID Server. For more information, see MID Server.

    Map API data to your data model

    After a REST service is imported, use the Model Manager to define entities and map API response fields to the data model. For more information, see Add a REST entity to a model operation.

    REST API connector tables

    For information about the REST API connector tables added for Zero Copy Connector for ERP, see REST API connector for Zero Copy Connector for ERP tables.