Create an integration key

post

https://api.cardda.com/v1/integrations/keys

Creates an integration key against a service (key_service_id), owned by the calling
user and enabled on creation.

The required secret depends on the service's auth method: token-based services
require token; password-based services require password and identifier. The
auth_method and identifier_type are copied from the service.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Body to create an integration key. The required secret depends on the auth method of
the referenced key service: token-based services require token; password-based
services require password and identifier. The key is created enabled and owned by
the calling user; auth_method and identifier_type are copied from the key service.

key_service_id

string

required

Id of the integration service (Integrations::KeyService) to authenticate against.

token

string

API token. Required when the key service's auth method is token.

password

string

Account password. Required when the key service's auth method is password.

identifier

string

Account identifier (e.g. RUT). Required when the auth method is password.

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Finance endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized - missing or invalid authentication token.

404

The referenced key service was not found.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The created integration key.

422Validation failed (e.g. a required secret for the service's auth method is missing).