OAuth 2 (client credentials)

Introduction

Patchworks API requests must be authenticated with a bearer token. To obtain a token, you need to send a login request which includes credentials that you use to access the Patchworks dashboard.

This authentication mechanism is pre-configured and ready to use in our Core API Postman collection - if you haven't seen it, we advise checking this first!

Obtaining a token for Patchworks API authentication

Show me

Step 1 Create a POST request for the following endpoint:

https://svc-fabric.pwks.co/api/v1/login

This endpoint is for the Patchworks production environment.

Step 2 In the request body, add the email and password that you use to log into the Patchworks dashboard. You should add this as JSON - for example:

{
    "email": "[email protected]",
    "password": "mypassword123*"
}

Step 3 Send the request - if successful, a token is returned. For example:

Access tokens are valid for 24 hours - for example: Issued: Wednesday 20th July at 10:03:08 GMT Expires: Tuesday 21st July at 10:03:08 GMT

Step 4 Save this token ready for use in your API requests.