GET login/users/:user id/profile

From Social ID Developers
(Difference between revisions)
Jump to: navigation, search
 
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
−
#REDIRECT [[GET login/users/:user id/profile PT-BR]]
+
== Description ==
 +
 
 +
Returns the user profile (complete or partial). The user profile is built with all social networks the user has associated to his account.
 +
 
 +
== Resource URL ==
 +
 
 +
  GET https://api.socialidnow.com/v1/marketing/login/users/:user_id/profile
 +
 
 +
== Parameters ==
 +
 
 +
=== URL Parameters ===
 +
 
 +
{|
 +
! align="left" width="200px" | user_id
 +
| width="200px" | required
 +
| user identifier.
 +
|-
 +
! align="left" width="200px" | fields
 +
| width="200px" | optional
 +
| a list of user profile field names to be returned, joined by commas. See [[Social Profile Fields]]. Default: all fields are returned.
 +
|-
 +
! align="left" width="200px" | refresh
 +
| width="200px" | optional
 +
| whether the profile should be refreshed at the moment of the request. Default: false. Notice: this API call may take longer if this parameter is set to true due to the social network latency.
 +
|}
 +
 
 +
== Authentication ==
 +
 
 +
This API requires Account authentication. See [[Authentication]].
 +
 
 +
== Response ==
 +
 
 +
The response returns the [[Social Profile Fields]] or only the ones required by the parameters "fields".
 +
 
 +
== Examples ==
 +
 
 +
=== Without fields ===
 +
 
 +
==== Request ====
 +
 
 +
Returns all profile fields of user "340".
 +
 
 +
  curl -X GET 'https://api.socialidnow.com/v1/marketing/login/users/340/profile' \
 +
        --user <api_id>:<api_secret>
 +
 
 +
==== Response ====
 +
 
 +
===== Response Body =====
 +
 
 +
{
 +
      "about_me": "Software Engineer",
 +
      "addresses": [
 +
        {
 +
          "country":"br",
 +
          "formatted":"Campinas, SP, Brasil",
 +
          "locality":null,
 +
          "postal_code":null,
 +
          "region":null,
 +
          "street_address":null
 +
        }
 +
      ],
 +
      "birthday": "1980-10-01",
 +
      "certifications":[],
 +
      "courses":[],
 +
      "current_location": "Campinas, SP, Brasil",
 +
      "display_name": "John Doe",
 +
      "educations": [
 +
        {
 +
          "degree": "null",
 +
          "description": null,
 +
          "end_date": null,
 +
          "name": "Universidade Estadual de Campinas",
 +
          "start_date": null,
 +
          "type": "Graduate School"
 +
        }
 +
      ],
 +
      "emails": [
 +
        {
 +
          "primary": true,
 +
          "type": "other",
 +
          "value": "john.doe@somedomain.com"
 +
        }
 +
      ],
 +
      "gender": "male",
 +
      "hometown": "San Francisco, CA",
 +
      "honors": null,
 +
      "ims": [
 +
      ],
 +
      "industry": null,
 +
      "interested_in_meeting": [
 +
      ],
 +
      "interests": [
 +
        {
 +
          "category": "Interest",
 +
          "link": "http://www.facebook.com/pages/Conference-on-Computer-Vision-and-Pattern-Recognition/137428412945882",
 +
          "name": "Conference on Computer Vision and Pattern Recognition"
 +
        }
 +
      ],
 +
      "languages_spoken": [
 +
        {
 +
          "level": null,
 +
          "name": "Portuguese"
 +
        }
 +
      ],
 +
      "likes": [
 +
        {
 +
          "category": "Product/service",
 +
          "link": "http://www.facebook.com/coffeebeantech",
 +
          "name": "Coffee Bean Technology"
 +
        }
 +
      ],
 +
      "locale": "en",
 +
      "name": {
 +
        "family_name": null,
 +
        "formatted": "John Doe",
 +
        "given_name": null,
 +
        "honorific_prefix": null,
 +
        "honorific_suffix": null,
 +
        "middle_name": null
 +
      },
 +
      "nickname": null,
 +
      "organizations": [
 +
        {
 +
          "department": null,
 +
          "description": null,
 +
          "end_date": "2006-01-01",
 +
          "location": "São Paulo, SP",
 +
          "name": "Coffee Bean Technology",
 +
          "primary": false,
 +
          "start_date": "2001-01-01",
 +
          "title": "Software Developer",
 +
          "type": null
 +
        }
 +
      ],
 +
      "phone_numbers": [
 +
      ],
 +
      "picture_url": "http://somedomain.com/johndoe.jpg",
 +
      "political_views": null,
 +
      "preferred_username": "johndoe",
 +
      "professional_headline": null,
 +
      "profile_url": null,
 +
      "providers": {
 +
        "facebook": {
 +
          "id": "12345",
 +
          "picture_url": "https://www.facebook.com/johndoe",
 +
          "profile_url": "https://www.facebook.com/johndoe.png",
 +
          "username": "johndoe"
 +
        },
 +
        "twitter": {
 +
          "id": "456",
 +
          "picture_url": "https://www.twitter.com/johndoe",
 +
          "profile_url": "https://www.twitter.com/johndoe.png",
 +
          "username": "johndoe"
 +
        },
 +
        "linkedin": {
 +
          "id": "http://www.linkedin.com/in/johndoe",
 +
          "picture_url": "http://www.linkedin.com/in/johndoe.png",
 +
          "profile_url": "http://www.linkedin.com/in/johndoe"
 +
        },
 +
        "gplus": {
 +
          "id": "456",
 +
          "picture_url": "https://plus.google.com/johndoe",
 +
          "profile_url": "https://plus.google.com/johndoe.png",
 +
          "username": "johndoe"
 +
        }
 +
      },
 +
      "quotes": [
 +
      ],
 +
      "relationship_status": "married",
 +
      "religion": null,
 +
      "significant_other": null,
 +
      "specialties": null,
 +
      "status": null,
 +
      "updated": "2012-12-22T01:27:13Z",
 +
      "urls": [
 +
        {
 +
          "primary": false,
 +
          "type": null,
 +
          "value": "http://somedomain.com/johndoe"
 +
        }
 +
      ],
 +
      "utc_offset": "-10800",
 +
      "verified_account": "f",
 +
      "verified_email": "john.doe@somedomain.com"
 +
}
 +
 
 +
=== With fields ===
 +
 
 +
==== Request ====
 +
 
 +
Returns current_location, display_name and verified_email profile fields of user "340".
 +
 
 +
  curl -X GET 'https://api.socialidnow.com/v1/marketing/login/users/340/profile?fields=display_name,verified_email,current_location' \
 +
        --user <api_id>:<api_secret>
 +
 
 +
==== Response ====
 +
 
 +
===== Response Body =====
 +
 
 +
{
 +
      "current_location": "Campinas, SP, Brasil",
 +
      "display_name": "John Doe",
 +
      "verified_email": "john.doe@somedomain.com"
 +
}

Latest revision as of 16:42, 30 December 2021

Contents

Description

Returns the user profile (complete or partial). The user profile is built with all social networks the user has associated to his account.

Resource URL 

  GET https://api.socialidnow.com/v1/marketing/login/users/:user_id/profile

Parameters

URL Parameters

user_id required user identifier.
fields optional a list of user profile field names to be returned, joined by commas. See Social Profile Fields. Default: all fields are returned.
refresh optional whether the profile should be refreshed at the moment of the request. Default: false. Notice: this API call may take longer if this parameter is set to true due to the social network latency.

Authentication

This API requires Account authentication. See Authentication.

Response

The response returns the Social Profile Fields or only the ones required by the parameters "fields".

Examples

Without fields

Request

Returns all profile fields of user "340". 

 curl -X GET 'https://api.socialidnow.com/v1/marketing/login/users/340/profile' \
        --user <api_id>:<api_secret>

Response

Response Body 
{
     "about_me": "Software Engineer",
     "addresses": [
       {
         "country":"br",
         "formatted":"Campinas, SP, Brasil",
         "locality":null,
         "postal_code":null,
         "region":null,
         "street_address":null
       }
     ],
     "birthday": "1980-10-01",
     "certifications":[],
     "courses":[],
     "current_location": "Campinas, SP, Brasil",
     "display_name": "John Doe",
     "educations": [
       {
         "degree": "null",
         "description": null,
         "end_date": null,
         "name": "Universidade Estadual de Campinas",
         "start_date": null,
         "type": "Graduate School"
       }
     ],
     "emails": [
       {
         "primary": true,
         "type": "other",
         "value": "john.doe@somedomain.com"
       }
     ],
     "gender": "male",
     "hometown": "San Francisco, CA",
     "honors": null,
     "ims": [
     ],
     "industry": null,
     "interested_in_meeting": [
     ],
     "interests": [
       {
         "category": "Interest",
         "link": "http://www.facebook.com/pages/Conference-on-Computer-Vision-and-Pattern-Recognition/137428412945882",
         "name": "Conference on Computer Vision and Pattern Recognition"
       }
     ],
     "languages_spoken": [
       {
         "level": null,
         "name": "Portuguese"
       }
     ],
     "likes": [
       {
         "category": "Product/service",
         "link": "http://www.facebook.com/coffeebeantech",
         "name": "Coffee Bean Technology"
       }
     ],
     "locale": "en",
     "name": {
       "family_name": null,
       "formatted": "John Doe",
       "given_name": null,
       "honorific_prefix": null,
       "honorific_suffix": null,
       "middle_name": null
     },
     "nickname": null,
     "organizations": [
       {
         "department": null,
         "description": null,
         "end_date": "2006-01-01",
         "location": "São Paulo, SP",
         "name": "Coffee Bean Technology",
         "primary": false,
         "start_date": "2001-01-01",
         "title": "Software Developer",
         "type": null
       }
     ],
     "phone_numbers": [
     ],
     "picture_url": "http://somedomain.com/johndoe.jpg",
     "political_views": null,
     "preferred_username": "johndoe",
     "professional_headline": null,
     "profile_url": null,
     "providers": {
       "facebook": {
          "id": "12345",
          "picture_url": "https://www.facebook.com/johndoe",
          "profile_url": "https://www.facebook.com/johndoe.png",
          "username": "johndoe"
       },
       "twitter": {
          "id": "456",
          "picture_url": "https://www.twitter.com/johndoe",
          "profile_url": "https://www.twitter.com/johndoe.png",
          "username": "johndoe"
       },
       "linkedin": {
          "id": "http://www.linkedin.com/in/johndoe",
          "picture_url": "http://www.linkedin.com/in/johndoe.png",
          "profile_url": "http://www.linkedin.com/in/johndoe"
       },
       "gplus": {
          "id": "456",
          "picture_url": "https://plus.google.com/johndoe",
          "profile_url": "https://plus.google.com/johndoe.png",
          "username": "johndoe"
       }
     },
     "quotes": [
     ],
     "relationship_status": "married",
     "religion": null,
     "significant_other": null,
     "specialties": null,
     "status": null,
     "updated": "2012-12-22T01:27:13Z",
     "urls": [
       {
         "primary": false,
         "type": null,
         "value": "http://somedomain.com/johndoe"
       }
     ],
     "utc_offset": "-10800",
     "verified_account": "f",
     "verified_email": "john.doe@somedomain.com"
}

With fields

Request

Returns current_location, display_name and verified_email profile fields of user "340". 

 curl -X GET 'https://api.socialidnow.com/v1/marketing/login/users/340/profile?fields=display_name,verified_email,current_location' \
        --user <api_id>:<api_secret>

Response

Response Body 
{
     "current_location": "Campinas, SP, Brasil",
     "display_name": "John Doe",
     "verified_email": "john.doe@somedomain.com"
}
Retrieved from "https://dev.socialidnow.com/index.php?title=GET_login/users/:user_id/profile&oldid=3321"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox