Basic Sign-up and API Interaction

A basic sign-up process involves creating an entity (user) and receiving their dpKey (id). This is simply done by making an authenticated request to endpoint 1001: Create account:

{
   "firstName": "Alan",
   "lastName": "Turing",
   "userName": "a_turing",
   "password": "3n1gm4"
}

{
   "dpKey": 12345,
   "firstName": "Alan",
   "lastName": "Turing",
   "userName": "a_turing"
}

The entity has now been created, and the dpKey from the response can be used to update or remove the entity, change the password, assign tracks, add social connections etc. In most situations, the API accepts the dpKey as a URL parameter, so Alan's details could be retrieved with a GET request to this URL:

https://api.dialogportal.com/v1/user/dp-key/12345/data

If you choose to store the dpKey indefinitely in your app, then you will not need to authenticate the entity. However, if you only want to use short-term storage, or provide log-in functionality for existing entities, then you can use endpoint 2001: Authenticate to validate the user, and retrieve the dpKey:

{
   "authType": "native",
   "loginID": "a_turing",
   "password": "3n1gm4"
}

{
   "dpKey": 12345,
   "firstName": "Alan",
   "lastName": "Turing",
   "userName": "a_turing"
}