Submit an API Spec With an Absolute URL
Provide a full, absolute URL to the spec.
Required Editions
| Available in: Lightning Experience |
| Available in: Enterprise, Performance, Unlimited, and Developer Editions |
| User Permissions Needed | |
|---|---|
| To manage connections: | Customize Application |
Important Before you can use an absolute URL, you must add the URL to your Remote Sites settings.
To register an API spec using an absolute URL:
- Make sure that the URL has been added to your Remote Sites settings.
- From Setup in Lightning Experience, enter External Services in the Quick Find box, and select External Services.
- Click New External Service.
- On the Select an API Source page, select whether you’re importing an API spec From Mulesoft Anypoint Platform, or From API Specification. Since we're using our own spec in this example, select From API Specification.
- Under External Service Name, enter a unique service name.
- Under Description, enter an optional description. A good, short description can help distinguish one service from another in a long list of services.
- Click under Select a Named Credential and select a named credential from the list.
- Under Service Schema, select Absolute URL to upload and register your schema. The URL must point to a valid OpenAPI 2.0 or 3.0, and a JSON or YAML-compliant schema.
-
Enter an absolute URL path to the schema under URL. For
example,
https://my_endpoint.example.com/accountSchema.json. The absolute URL can point to a different domain than the one specified in Named Credentials. - Press Enter on your keyboard, or click outside of the URL box. The system begins to validate the schema.
-
If one or more errors are found during the validation process, a message (or
series of messages) gives specific details about the error. You make corrections
to the schema by editing it directly in the text editor and clicking
Validate to revalidate your changes, or by modifying
an offline copy and re-registering it. There are two types of errors:
- Syntax or logical errors—Must be fixed to complete the registration process. To resolve an error, use the error message to discover the type and location of the error. Make corrections, and click Validate. Syntax error messages provide line and column number location.
- Syntax or logical warnings—You don’t need to fix warnings to complete a registration. But the respective schema components are ignored by the External Services and aren’t registered. To fix warnings, use the guidance in the warning message, make corrections, and click Validate.
-
Click Save & Next.
Note If your schema includes non-supported media types, the system displays the Associate operations with supported media types page. Select a valid mapping for each non-supported type, as described in Mapping Media Types During Registration. - Select the operations you want to import into your external service registration. You can select up to 3,000 operations per org, and up to 3,000 active objects per org. If you exceed either of these limits, divide the operations in your schema across separate registrations. For information about limits, see External Services Considerations. For information about “objects” in Open API schemas, see Basic Structure (OpenAPI 2.0) and Basic Structure (OpenAPI 3.0)
- Click Next.
- Click Done.
Did this article solve your issue?
Let us know so we can improve!
