NATS5 REST API Member GET matching
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GET /member/matching
Description
- Find matching members for member fields
Resource URL
- http://domain/api/member/matching
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- memberid
- type: digit
- optional
- fields
- type: string_list (Either a comma-separated string of strings, or a JSON array of strings)
- optional
Example Request
Method: GET
URL: http://domain/api/member/matching
Query String: memberid=3&fields=username
Response:
{ "success": true, "matches": [ { "field": "username", "success": true, "count": "1", "search": { "username": "test username" }, "params": { "count_only": true, "no_like_searches": true, "search": { "username": "test username" } } } ] }
Example Code
PHP
<?php $headers = array( //set your username and API key here 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: tmm1phrvezsbu' ); $url = 'http://yourdomain.com'; //set your NATS URL here $data = Array( 'memberid' => '3', 'fields' => 'username', ); $request = Array( 'method' => 'GET', 'path' => 'v1/member/matching', 'data' => $data ); /*code below is the same for (almost) every API call */ $curl = curl_init(); $url = $url.'/api/'.$request['path']; $query = http_build_query($request['data']); if($request['method'] == 'GET'){ //add query string parameters to the end of the url $url = $url.'?'.$query; }else{ //send parameters as POST fields curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS, $query); if($request['method'] != 'POST'){ $headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method } } curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); $resp = curl_exec($curl); //dumps an associative array representation of the json var_dump(json_decode($resp, true)); // Close request to clear up some resources curl_close($curl); ?>