OCocrolus
Business Verification (Deprecated)

Vendor authentication (Deprecated)

Store a vendor-generated API key to enable third-party integrations.

put/v1/developer/auth/vendor/{vendor_name}

Request

  • Base URL
    https://api.ocrolus.com
  • URL
    https://api.ocrolus.com/v1/developer/auth/vendor/{vendor_name}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.ocrolus.com/oauth/token

Path parameters

vendor_name'middesk' required

The vendor that you're granting Ocrolus access to. Currently, we only support the value of middesk.

Request body

api_keystring required

The API key provided by the vendor given in vendor_name. Their documentation will explain how you can obtain a key.

Response

Successful Response

statusinteger

A numerical code that indicates the status of the request.

messagestring

A textual description that indicates details about this response's status.

responsestring

Data potentially retained from the servor.

Example response

{
  "status": 200,
  "message": "OK",
  "response": "Successfully stored API key"
}

Changes

No recorded changes to this operation across all 1 revision of this API.