Page tree
Skip to end of metadata
Go to start of metadata

POST /login

User Login

Real user authentication, is the initial login step for getting the cookie that needs to be passed to the rest of the calls to the API.

Request URL

https://{client_id}.salesseek.net/api/login

Request Body
{
	email_address: "user@mail.com"
	password: "My_Very_Secure_Pasword"    
}

 

Request Header

Request Header
{
    Content-Type: application/x-www-form-urlencoded
}

 

Response Type

Response content type: JSON User

ModelExample of Response

Individual  {

comments(string): Specific text field for general information about this individual,

communication(Array[Communication]): The list of ways to communicate with this individual, including email, phone, LinkedIn, Facebook, Twitter and GooglePlus,

created(timestamp): individual creation date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

first_name(string): Individual first name,

id(string): unique identifier for this individual,

is_favorite(boolean): true or false if this individual is favorite for the current SalesSeek User (false by default),

locations(Array[Location]): List of addresses associated to this individual,

last_name(string): Individual last name,

modified(string): individual latest modification date, formatted as YYYY-MM-ddThh_mm_ss.msecs,

organization_name(string): Organization Name this individual belongs to,

owner_id(string): ID for the SalesSeek User who owns this individual,

photo_url(string): entire url for an image assigned to this individual,

short_id(string): alias: shorter but still unique identifier for this individual,

source(Source): Lead source of this individual if defined,

source_id(string): Lead Source ID for this individual, if defined,

type(string): "individuals",

permissions(Array[string]): [

0: "salesseek.core.all_permissions"

1: "salesseek.core.edit"

2: "salesseek.core.view"

],

custom_fields(Associative Array): {

CustomFieldId1(String): CustomFieldValue1(String),

CustomFieldId2(String): CustomFieldValue2(String),

...

}

}

Source(JSON): {

id(string): Lead Source ID for this individual, if defined,

name(string): Text name of the lead source associated to tis individual, if defined,

}

Location  {

comments(string):Additional information related to the location, eg: working hours,

name(string): Text identifier for this location, eg: Home, Work, etc,

id (string): unique identifier for this location,

address(string): Complete Address

 }

Communication(JSON) {

id(string): unique identifier for the communication,

comments(string): text with the comments of this communication,

medium(enum): one of the following values: email, phone, social.

name(string): communication name, could be one of the predefined: workhome, twitter, facebook, linkedin or googleplus,

value(string): the field value, depending on the medium this value should be formatted as an email (aaa@mmm.com) or a phone number (prefixes are allowed, eg: +1 555 666 777 888)

}


{
  short_id: "c89970", 
  is_admin: false, 
  favorites_id: "43404", 
  type: "users", 
  quota: [
	{"value": 10.0, "bucket_id": "991cdb6"}, 
	{"value": 20.0, "bucket_id": "8bc7f383"}, 
	{"value": 30.0, "bucket_id": "7aa206286"}
  ],, 
  preferences: {"default_dashboard": "team"}, 
  client_id: "669908d6f", 
  name: "Kate Wilson", 
  client: {
    short_id: "aptui", 
    client_id: "669908d6f", 
    name: "Demo Client for APTUI", 
    currencies: {
      AUD: 2, 
      BRL: 3
    }, 
    marketing_groups": {
      groups: [
        "5262b998a6",
        "fc899a0c6c"
      ]
    }
    facebook_page_id: 998877665544, 
    default_currency: "USD", 
    type: "clients", 
    id: "669908d6f"
  }, 
  id: "5f8c9", 
  email_address: "wilson@gmail.com", 
  ical_url: "/users/5f048c9/icalendar_feed?token=a7b6e", 
  password_reset_required: true
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
salesseekOut-The SalesSeek Cookie to be used in all the rest of API RequestsCookie
Content-TypeInYMandatory to set the content type of the Request Body parameters (credentials)Text
CredentialsInYJSON containing the email and password to be logged inJSON

 


 

DELETE /logout

Logs out the current user

Executes the logout process for the current SalesSeek user

Request URL

https://{client_id}.salesseek.net/api/logout

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
      

 


 

POST /forgotten

Current reporting forgoten password

The user has forgoten his password for his SalesSeek User so requests a reset. After providing his email address SalesSeek will send to his inbox a link to validate this person wanted to change manually his password.

Request URL

https://{client_id}.salesseek.net/api/forgotten

Request Body
{
	email_address: "user@mail.com"
    callback_url:"https://saleseekclient.salesseek.net/#reset"  #the next web page to open after reseting the pwd
}

 

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
      

 


 

POST /reset

Current User changing his password

With the information provided in the email which was sent to the user email inbox this person will be able to get the user_id and token to setup a new password for his account

Request URL

https://{client_id}.salesseek.net/api/reset

Request Body
{
	user_id:"b8146356634",
    token:"76ef98545e738a51",
    password:"I_will_remember_this_new_password"
}

 

Response Type

Response content type: null

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
      
  • No labels