splash-extended

by tarabogart13

GitHub Readme.md

Splash-Extended

A simple Template to get your Salesforce Contacts online.

Login as an Administrator: username: admin password: admin

Deploy

After configuring the Heroku Connect Addon, please import the contacts-mapping.json into Heroku Connect.

REST API Specification v2 (for calling the Java Backend)

Login and get a User Token back

  • Request: http://localhost:8080/splash-extended/user/login
  • Method Type: POST
  • Header Values: Content-Type: application/json; Example:
  • Request Data: {"username":"user1","password":"user1"}
  • Response Data: { "firstName": "Max", "lastName": "Bauer", "role": "ROLE_CUSTOMER", "userId": "2", "token": "332bc0ddba3c4bc792c4829ff3834ca9" }

Login with CAPTCHA and get a User Token back

{
    "username":"user1",
    "password":"user1",
    "recaptcha_challenge_field":"xxxx",
    "recaptcha_response_field":"yyyy"
}
  • Responses:
    • ResponseCode: 200
      • Data:
      {
          "firstName": "Max",
          "lastName": "Bauer",
          "role": "ROLE_CUSTOMER",
          "userId": "2",
          "token": "332bc0ddba3c4bc792c4829ff3834ca9"
      }
      
    • ResponseCode: 412 (captcha failed)
      • Data: null
    • ResponseCode: 401 (login failed)
      • Data: null

Create New User

Example:

  • Request Data:
{  
    "email": "max@gmx.de",
    "mainName": "Max",
    "mainSurname": "Bauerfeld",
    "mainCity": "Sindelfingen",
    "mainCountry": "Deutschland",
    "mainZipcode": "71063",
    "mainStreet": "Sindelfingen",
    "mainPhone": "071122872"
}
  • Response Data: password of the new generated user

Create new Password

Contact Object

{
    "email": "max@gmx.de",
    "mainName": "Max",
    "mainSurname": "Bauerfeld",
    "mainCity": "Hockenheim",
    "mainCountry": "Deutschland",
    "mainZipcode": "71063",
    "mainStreet": "Sindelfingen",
    "mainPhone": "071122872"
}

Get all Contacts

{
    "2": "Bauerfeld",
    "3": "Metzger"
}

Search Contacts by last name - or a part of it

{
    "2": "Bauerfeld"
}

Update Contact Object

{
    "email": "max@gmx.de",
    "mainName": "Max",
    "mainSurname": "Bauerfeld",
    "mainCity": "Hockenheim",
    "mainCountry": "Deutschland",
    "mainZipcode": "71063",
    "mainStreet": "Sindelfingen",
    "mainPhone": "071122872"
}
  • Response Data: null

License

Orientation is MIT licensed. See LICENSE for details.