As a start please obtain your client_id and client_secret from Planky API keys
POST
/oauth/v2/token
Planky uses access tokens to authenticate and authorise API requests.To obtain your access token, please ensure you have created a Planky user account. The access token, which is valid for a limited time, is provided using an authorisation header with structure Authorisation: Bearer access_token. Upon expiration, calls to the API with that token will return the error code 401 Unauthorised and a new access token has to be recreated by repeating the steps above.
Keep your credentials secret
Do not share your client_id and client_secret with anyone.
Parameters
Parameter | Data type | Required? | Description |
---|---|---|---|
client_id | string | yes | OAuth client_id |
client_secret | string | yes | OAuth client_secret |
grant_type | string | yes | Please set the grant to "client_credentials" |
Request example:
1
2
3
4
5
6
7
curl --location --request POST 'https://api.friendlyscore.com/oauth/v2/token' \
--header 'Content-Type: application/json' \
--data-raw '{
"client_id": "{client_id}",
"client_secret": "{client_secret}",
"grant_type": "client_credentials"
}'
Response example:
1
2
3
4
5
6
{
"access_token": "abcd",
"expires_in": 3600,
"token_type": "bearer",
"scope": null
}
Was this article helpful?
Friendly Score UK Ltd.
84 Brook Street
London W1K 5EH
Call us on +44 20 3709 6726
Company registered in England
Company number 09168668, ICO ZA111687
VAT registration number 206 9758 80
Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)