Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Unique call name:  the name for this endpoint within ACP.
  • Endpoint http method:  the HTTP header for accessing this endpoint (GET, POST, etc).
  • Endpoint pathname:  the path of this API action.  Note: the connector configuration modal on each ACP Workflow will ask you for the location of the API service.  This pathname is the path to be used *after* the location of the service is defined. For example, if an API endpoint is “https://127.0.0.1/services/action1/”, the connector location will be defined as “https://127.0.0.1/services” and the endpoint pathname will be “/action1/”.  
  • Endpoint family name:  ACP organizes API endpoints into families for easier lookups.  This field allows you to define what family this endpoint falls into.  Families are automatically created from the contents of this field.
  • Friendly endpoint name:  a more user-friendly name for this endpoint.  
  • Endpoint description:  a short description of what this endpoint does.
  • Rollback call:  the unique call name which will be invoked if this call fails and rollbacks are enabled.  Optional.
  • Use this call to test credentials:  When the user is filling out the connector’s location and authentication details in a Workflow the ‘test’ button does a quick call to a specified endpoint to verify the credentials are working.  This toggle defines whether or not this endpoint is appropriate for this test.
  • Content-type header:  The content-type header sent to the API service by the HTTP protocol.  

...