Authentication
Credentials
In order to access the endpoints for both the Luminate Music and SVM APIs, the user must first authenticate via the /auth
POST endpoint. The following information will need to be inputted: API key, username, and password.
You can access the authentication endpoint by visiting the "Authentication" section in the API Reference or by clicking here.
If you want to receive access to Luminate's APIs or are unable to authenticate using your credentials, please reach out to [email protected] for support.
Request
The API key will be included in the headers of the request, while the username and password will included in the body.
curl --request POST \
--url https://api.luminatedata.com/auth \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-api-key: APIKEY123' \
--data [email protected] \
--data password=Password
Response
If the request is successful, the API will respond with an authentication token (via the access_token
field) and a duration for its lifespan (via the expires_in
field). By default, authentication tokens will be valid for 86400 seconds (24 hours).
{
"access_token": "eyJraWQiOiI2MVZkR3V1elpqVmdrYmZLMkpXVThiZWZ6YXEySHpONm82clcwcFM1X2VFIiwiYWxnIjoiUlMyNTYifQ.eyJ2ZXIiOjEsImp0aSI6IkFULmw0RldxSGg0TTlSNF9QSTJ2Y2FEc1dpSHd3MWQ3LXdYb3NtZlJHRkZ5ejgiLCJpc3MiOiJodHRwczovL3ZhbGVuY2Uub2t0YS5jb20vb2ABBREVIATEDAUTHENTICATIONTOKEN",
"expires_in": 86400
}
If the request is unsuccessful, the API will return a 401 error and the response will provide a reason for the failed authentication attempt.
{
"error": {
"errors": [
{
"error_code": "00018",
"error_type": "Unauthorized",
"message": "API key invalid or not provided."
}
],
"code": 401,
"message": "Unauthorized"
}
}
Access
Once an authentication token has been obtained, it will need to be provided (along with the API Key) in the headers of all endpoints.
curl --request GET \
--url https://api.luminatedata.com/songs/ID123 \
--header 'accept: application/vnd.luminate-data.svc-apibff.v1+json' \
--header 'authorization: AUTHTOKEN123' \
--header 'x-api-key: APIKEY123'
Updated 6 days ago