Oauth

Authenticate Oauth

post

To be confirmed.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/oauth/authenticate

HTTPcURLJavaScriptPython

POST /api/v1/oauth/authenticate HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Authorise Oauth

post

Authorises a connector using OAuth, creating a new authenticated instance.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

application/json

authentication_implementation_idstringRequired

timezonestringRequired

date_formatstringRequired

rate_limit_unitstring · enumRequiredPossible values:

rate_limit_durationintegerRequired

connection_pool_idintegerOptional

variablesstringOptional

session_idstringOptional

platform_app_keystringOptional

certificate_idstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/oauth/authorise

HTTPcURLJavaScriptPython

POST /api/v1/oauth/authorise HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "authentication_implementation_id": 1,
  "timezone": "example_timezone",
  "date_format": "example_date_format",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "connection_pool_id": 1,
  "variables": "example_variables",
  "session_id": 1,
  "platform_app_key": "example_platform_app_key",
  "certificate_id": 1
}

{}

Authenticate Woo App Auth

post

To be confirmed.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/oauth/woo-app-auth

HTTPcURLJavaScriptPython

POST /api/v1/oauth/woo-app-auth HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Reauthorise Oauth

patch

Reauthorises an existing OAuth connector instance.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

connectorstringRequired

The connector identifier.

Body

application/json

authentication_implementation_idstringOptional

typestringOptional

timezonestringOptional

date_formatstringOptional

rate_limit_unitstring · enumOptionalPossible values:

rate_limit_durationintegerOptional

connection_pool_idintegerOptional

variablesstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch/api/v1/oauth/{connector}/reauthorise

HTTPcURLJavaScriptPython

PATCH /api/v1/oauth/{connector}/reauthorise HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 232

{
  "authentication_implementation_id": 1,
  "type": "example_type",
  "timezone": "example_timezone",
  "date_format": "example_date_format",
  "rate_limit_unit": "second",
  "rate_limit_duration": 1,
  "connection_pool_id": 1,
  "variables": "example_variables"
}

{}