Authorization

The API is protected using OAUTH2. A sample user has been created so the API can be tried by anybody.

If you require integration with our platform, please get in touch with us at hello@refme.com.

The access token for the sample user is:

ec4a4982d500feabd0629c4d71355f003b16b5a5c4d446974bdf0a3xxxxxxxxx

Versioning

The API is versioned using a custom media type:

application/vnd.refme-v1+json

Specifying an API version via the Accept header is required. Otherwise, the server will return 415 Unsupported Media Type.

Example

You can request the sample user profile JSON representation, with the v1 of the api by making the following request:

  curl 'https://api.refme.com/api/user/profile' 
    -H 'Authorization: Bearer ec4a4982d500feabd0629c4d71355f003b16b5a5c4d446974bdf0a3xxxxxxxxx' 
    -H 'Accept: application/vnd.refme-v1+json'

Response

  {
    "email": "test-api-docs-user@refme.com",
    "name": "Test API Docs User"
  }