API Key Authentication

< 1 min read

For connectors that are authenticated using an API key provided by the 3rd party app.

Your user’s API Key will need to be collected in your application and sent to Cyclr.

You can update an existing Account Connector with this Cyclr API Request where AuthValue is set to the API Key value:

Request: #

PUT /v1.0/account/connectors/{Account Connector ID}
Authorization Bearer ********************
X-Cyclr-Account: 00000000-0000-0000-0000-000000000000

    {
        "AuthValue": "0000000000000000000000000000000000000000"
    }

Response: #

    {
        "Id": 0,
        "Name": "Pipedrive",
        "Description": null,
        "AuthValue": "0000000000000000000000000000000000000000",
        "Authenticated": true,
        "Connector": {
            "Id": 0,
            "Name": "Pipedrive",
            "Description": "Sales CRM for small teams with big ambitions.",
            "Status": "Approved",
            "Version": "1.0",
            "Icon": null,
            "AuthDescription": null,
            "AuthType": "ApiKey",
            "OAuth2Type": "Unknown",
            "AuthScheme": null
        },
        "IsPartnerIntegrationConnector": false,
        "Properties": [],
        "CustomFields": []
    }