README

此库允许开发人员通过对该网络的REST API端点的HTTP调用将TalentCircles网络集成到自己的应用程序中。

设置

使用composer设置简单易行。如果您还没有安装composer，请参阅这里的说明。一旦您有了composer，请从您的项目根目录使用以下命令

$ composer require talentcircles/php_sdk

用法

首先初始化SDK对象

// Use your Network URL, App ID, and Api Key to connect to your API.
// It is reccomended that this information be kept somewhere in your
// project that is not accessible from the public html directory.
$network_url='https://127.0.1.1';
$app_id='romeo-5931c22e4190b';
$api_key='Y1IgDgriOjAo5hKMzZ0RxC';

$tc = new TalentCirclesSDK($network_url, $app_id, $api_key);

然后调用以下任何函数之一来访问您要访问的TalentCircles网络上的数据。例如，要获取一个工作对象，请使用工作id调用getJob()

$obj_job = $tc->getJob(6579620);

函数

工作函数

getJob(INT $job_id) - 获取由$job_id标识的工作发布的单个工作对象

$obj_job = $tc->getJob(6579620);

getJobs(ARR $job_ids) - 获取由$job_ids数组标识的工作发布的多个工作对象

$job_ids = array(
    4551686,
    7480159
);
$ar_jobs = $tc->getJobs($job_ids);

getJobMatchingCandidates(INT $job_id) - 获取一个数组，包含可能适用于由$job_id标识的工作发布的候选用户对象

$ar_users = $tc->getJobMatchingCandidates(6579620);

getSimilarJobs(INT $job_id) - 获取一个数组，包含与由$job_id标识的工作发布类似的工作发布的工作对象

$ar_users = $tc->getSimilarJobs(6579620);

createJob(STR $job_title, STR $job_description, ARR $jobDetails) - 发布新的工作广告，返回新的工作对象

$jobTitle = "Advanced Front-end Developer";
$jobDescription = "We need somone really good at developing";

$jobDetails = array(
    'available_on' => 'November 14, 2017',
    'category_id' => 17,
    'commitment_level' => 'Full-Time',
    'apply_behavior' => 'url redirect',
    'urlRedirect' => 'https://talentcircles.com'
);

$ar_job = $tc->createJob($jobTitle, $jobDescription, $jobDetails);

searchJobs(ARR $search_params, INT $page, INT $results_per_page) - 使用SPHINX搜索从数据库中获取工作对象的数组

$search_params = array(
    'tenants' => 570
);

$page = 1;
$results_per_page = 10;

$ar_jobs = $tc->searchJobs($search_params, $page, $results_per_page);

updateJob(INT $job_id, ARR $update_data) - 更新由$job_id标识的现有工作发布，返回更新后的工作对象

$job_id = 8698590;

$update_data = array(
    'available_on' => 'November 11, 2017',
    'commitment_level' => 'Part-Time',
);

$obj_job = $tc->updateJob($job_id, $update_data);

用户函数

getUser(INT $user_id) - 获取由$user_id标识的用户个人资料的单一用户对象

$user_id = 12770260;
$obj_user = $tc->getUser($user_id);

getUsers(ARR $user_ids) - 获取由$user_ids数组标识的个人资料的用户对象的数组

$user_ids = array(
    12770260,
    12769405
);
$ar_users = $tc->getUsers($user_ids);

getUserMatchingJobs(INT $user_id) - 获取一个数组，包含可能适用于由$user_id标识的用户个人资料的职位对象

$user_id = 12770260;
$ar_jobs = $tc->getUserMatchingJobs($user_id);

getUserStories(INT $user_id, INT $offset, INT $limit) - 获取由$user_id标识的用户个人资料发布的文章对象的数组

$user_id = 10961800;
$ar_stories = $tc->getUserStories($user_id);

createUser(ARR $user_data) - 创建新的用户个人资料，返回新的用户对象

$user_data = array(
    'firstname' => 'Gerald',
    'lastname' => 'de Jager',
    'email' => 'gedj@austincity.gov',
    'zipcode' => 78704
);

$ar_user = $tc->createUser($user_data);

searchUsers(ARR $search_params, INT $page, INT $results_per_page) - 使用SPHINX搜索从数据库中获取用户对象的数组

$search_params = array(
    'circles' => 376
);

$page = 1;
$results_per_page = 10;

$ar_users = $tc->searchUsers($search_params, $page, $results_per_page);

updateUser(INT $user_id, ARR $update_data) - 更新由$user_id标识的现有用户个人资料，返回更新后的用户对象

$user_id = 12770260;

$update_data = array(
    'objective' => 'To improve my career a great deal.',
);

$obj_user = $tc->updateUser($user_id, $update_data);

圈子函数

getCircle(INT $circle_id) - 获取由$circle_id标识的单一圈子对象

$circle_id = 375;
$obj_circle = $tc->getCircle($circle_id);

getCircles(ARR $circle_ids) - 获取由$circle_ids数组标识的圈子对象的数组

$circle_ids = array(
    372,
    375
);
$ar_circles = $tc->getCircles($circle_ids);

getCircleJobs(INT $circle_id, INT $offset, INT $limit) - 获取发布到由$circle_id标识的圈子的工作对象的数组

$circle_id = 375;
$result_offset = 0;
$result_limit = 10;
$ar_jobs = $tc->getCircleJobs($circle_id, $result_offset, $result_limit);

getCircleMembers(INT $circle_id) - 获取由$circle_id标识的圈子成员的用户对象的数组

$circle_id = 375;
$ar_members = $tc->getCircleMembers($circle_id);

createCircle(ARR $circle_data) - 创建新的圈子，返回圈子对象

$circle_data = array(
    'circle_name' => 'An Okay Test Circle',
    'owner_id' => 10961800
);
$obj_circle = $tc->createCircle($circle_data);

postCircleStory(INT $circle_id, ARR $story_data) - 向由$circle_id标识的圈子发布新的文章，返回圈子对象

$circle_id = 375;
$story_details = array(
        'title' => 'A New Test Story',
        'story' => 'This story is really, really new.'
);

$obj_story = $tc->postCircleStory($circle_id, $story_details);

updateCircle(INT $circle_id, ARR $update_data) - 更新由$circle_id标识的现有圈子，返回更新后的圈子对象

$circle_id = 384;
$update_data = array(
    'circle_name' => 'Great Test Circle',
);
$obj_circle = $tc->updateCircle($circle_id, $update_data);

文章函数

getStory(INT $story_id) - 获取由$story_id标识的文章发布的单一文章对象

$story_id = 196;
$obj_story = $tc->getStory($story_id);

getStories(ARR $story_ids) - 根据故事ID数组 $story_ids 获取多个故事对象

$story_ids = array(
    196,
    197
);
$ar_stories = $tc->getStories($story_ids);

postStory(ARR $story_data) - 向一个Circle发布新的故事，返回故事对象

$story_data = array(
    'title' => 'A new test story ' . date("U"),
    'story' => 'This test story is really new.',
    'circle_id' => $circle_id
);
$obj_story = $tc->postStory($story_data);

此函数还可以通过将 $circle_ids 数组传递到 $story_data 数组的 'circle_id' 元素中来，将新的故事发布到多个Circle

$circle_ids = array(
    375,
    376
);
$story_data = array(
    'title' => 'Multiple Circle Test Story',
    'story' => 'This test story is being posted to two different circles.',
    'circle_id' => $circle_ids
);

$ar_stories = $tc->postStory($story_data);

updateStory(INT $story_id, ARR $story_data) - 更新由 $story_id 标识的现有故事发布，返回更新后的故事对象

$story_id = 240;
$story_data = array(
    'story' => 'The text of this story is being updated.',
);
$obj_story = $tc->updateStory($story_id, $story_data);

updateStories(ARR $story_ids, ARR $story_data) - 更新一组现有故事，这些故事由 $story_ids 数组标识，返回更新后的故事对象数组

$story_ids = array(
    240,
    241
);
$story_data = array(
    'story' => 'The text of this story is being updated.',
);
$obj_story = $tc->updateStory($story_ids, $story_data);