younifyd
Menu

Create A Custom API

Create a Custom API

POST/v2/settings/extensions/custom-apis

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Create A Custom API action (under Commerce Extensions).
  3. Fill in the fields below, then reference the result from later steps as {{createACustomApi.response.data}}.

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://useast.api.elasticpath.comhttps://euwest.api.elasticpath.com__custom__Default "https://useast.api.elasticpath.com"

baseUrlCustomstring
bodystring

The request body content (for POST, PUT, PATCH requests).

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 201 with an object. Read it in later steps with {{createACustomApi.response.data.<field>}}.

dataobject
idstring (uuid)

The unique identifier for the Custom API.

typestring

Specifies the type of the resource object, use `custom_api` for Custom APIs.

namestring

Specifies the name of this Custom API.

descriptionstring

Specifies the description for this Custom API.

slugstring

Specifies a unique slug identifier for the Custom API. The API Entries for the created Custom API will be accessible at the location `/v2/extensions/<slug>`.

api_typestring

Specifies a unique API type for this Custom API. Entries for this API will use this value for their `type` field. This field must be suffixed with `_ext` to distinguish it from built in APIs.

allow_upsertsboolean

Controls whether upsert operations are allowed for Custom API Entries via the `PUT` method. When set to `true`, it allows the creation of new Custom API Entries using `PUT` if the record doesn't exist, and updates the existing record if it does. When `false`, `PUT` requests can only update existing entries.

Default false

presentationobject2 fields

Optional presentation options for the Custom API.

linksobject1 fields
metaobject1 fields
relationshipsobject1 fields
json
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "string",
    "name": "string",
    "description": "string",
    "slug": "string",
    "api_type": "string",
    "allow_upserts": false,
    "presentation": {
      "page": "string",
      "section": "string"
    },
    "links": {
      "self": "string"
    },
    "meta": {
      "timestamps": {
        "created_at": "2017-01-10T11:41:19.244Z",
        "updated_at": "2017-01-10T11:41:19.244Z"
      }
    },
    "relationships": {
      "parent_apis": {
        "data": [
          {
            "id": "652e39d8-d613-493e-8c20-fef99ad6327a",
            "type": "custom_api"
          }
        ]
      }
    }
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.