v1

latestOpenAPI 3.0.32026-07-13347237.5 KB
Authorization

Generate Auth Secret

Use the /AuthSecret endpoint if you are a client of Flinks and want to grant access for a partner to retrieve data that is processed by Flinks. This endpoint generates a unique authorization token that your partner can use to securely access Flinks APIs.

get/v3/{customerId}/partnerdata/authsecret/{nameofpartner}

Path parameters

customerIdstring required

Key that grants access to the environment specified in the instance field. By default, the value is set to the Sandbox environment key.

nameofpartnerstring required

Name that you want to assign to this partner. If this field is left empty, the default value is PartnerTest.

Headers

Authorizationstring

Contains the Bearer Token (the API secret key that Flinks provides you with).

Response

Response Body

RequestIdstring

Unique identifier for this request.

PermissionIdstring

Unique identifier used to revoke access to Flinks APIs by disabling the authorization token. Save this value.

AuthSecretstring

The unique authorization token that your partner can use to securely access Flinks APIs.

Messagestring

Success message confirming the token was generated.