API Overview and Testing the API From Admin Area

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000088887-api-overview-and-testing-the-api-from-admin-area

The REST API system of the site allows developers to read, create, update and delete data from the website’s database using HTTP requests.

All HTTP requests are secured with an encrypted API Key, which must be sent in the X-Api-Key header. In addition, every request must be made with the corresponding HTTP request method specified below (GET, POST, PUT, or DELETE). If a request is sent using an HTTP request method that is not allowed for a given API endpoint, a 405 error (Invalid Request Method) will be returned. Please see the sections below for more details on these requirements.

The currently available API endpoints are:

Users

Create, read, update, and delete users from the database

/api/v2/user/get/{user_id}
/api/v2/user/create
/api/v2/user/update
/api/v2/token/delete

Leads

Create, read, update, match, and delete leads from the database

api/v2/leads/get/{id}
api/v2/leads/create
api/v2/leads/update
api/v2/leads/match
api/v2/leads/delete/{id}

Single Image Posts

Create, read, update, and delete single image posts from the database

/api/v2/data_posts/get/{post_id}
/api/v2/data_posts/create
/api/v2/data_posts/update
/api/v2/data_posts/delete

Multi Image Posts

Create, read, update, and delete multi image posts from the database

/api/v2/users_portfolio_groups/get/{group_id}
/api/v2/users_portfolio_groups/create
/api/v2/users_portfolio_groups/update
/api/v2/users_portfolio_groups/delete

Users Reviews

Create, read, update, and delete users reviews

/api/v2/users_reviews/get/{review_id}
/api/v2/users_reviews/create
/api/v2/users_reviews/update
/api/v2/users_reviews/delete

Post Types

Create, read, update, and delete post types from the database

/api/v2/data_categories/get/{data_id}
/api/v2/data_categories/create
/api/v2/data_categories/custom_fields
/api/v2/data_categories/update
/api/v2/data_categories/delete

API Endpoints

/api/v2/user/get/{user_id}

HTTP request method: GET

This endpoint accepts GET requests to read the data stored in the site’s database related to a single user.

The {user_id} is the user_id value stored in the users_data table in the site’s database. Data related to the specified user will be returned in JSON format.

Example cURL request to this endpoint:

curl -X 'GET' \
  'https://mywebsite.com/api/v2/user/get/1' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: myapikey'

/api/v2/user/create

HTTP request method: POST

This endpoint accepts POST requests to add a new user to the site’s database.

The Content-Type of all requests to this endpoint must be application/x-www-form-urlencoded. This endpoint will accept data for any column found in the users_data table, as well as data for columns that do not exist in that table. Any data sent for columns that do not exist will be stored in the users_meta table. Three pieces of data are required for a successful request: email, password, and subscription_id.

Example cURL request to this endpoint:

curl -X 'POST' \
  'https://mywebsite.com/api/v2/user/create' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: myapikey' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'last_login=20220714122910&google_id=1234567890-abc123def456.apps.googleusercontent.com&blog=https%3A%2F%2Fwww.blog.com&youtube=https%3A%2F%2Fwww.youtube.com%2Fyour_name&search_description=I'\''m%20the%20best%20developer%20on%20the%20planet...%20and%20very%20humble.&facebook=https%3A%2F%2Fwww.facebook.com%2Fyour_name&active=2&verified=0&position=Developer&experience=2016&about_me=%3Cp%3EExtra%20information%20about%20me%3C%2Fp%3E&zip_code=90210&city=Beverly%20Hills&country_ln=United%20States&lon=-118.4003563&featured=0&modtime=2022-07-14%2013%3A29%3A10&user_id=&rep_matters=Open%20from%208am%20-%207%20pm&affiliation=All%20credit%20cards%20accepted&state_ln=California&instagram=https%3A%2F%2Fwww.instagram.com%2Fyour_name&cv=forms%2F12-cv-1657841003.png&twitter=https%3A%2F%2Fwww.twitter.com%2Fyour_name&facebook_id=samplememberfb&last_name=Smith&listing_type=Individual&signup_date=20220714122910&country_code=US&awards=Nobel%20Peace%20Prize&nationwide=0&first_name=John&phone_number=555-555-555&pinterest=https%3A%2F%2Fwww.pinterest.com%2Fyour_name&website=https%3A%2F%2Fwww.mywebsite.com&state_code=CA&password=mypassword123&quote=Work%20Hard%2C%20Play%20Hard&credentials=Masters%20Degree%20in%20Computer%20Science&email=sample%40member.com&company=Google&address1=123%20Broadway%20Ave&subscription_id=1&linkedin=https%3A%2F%2Fwww.linkedin.com%2Fin%2Fyour_name&address2=Apartment%20%23555&profession_id=1&lat=34.0736204'

/api/v2/user/delete

HTTP request method: DELETE

This endpoint accepts DELETE requests to delete a user and their related data from the site’s database.

The Content-Type of all requests to this endpoint must be application/x-www-form-urlencoded. To successfully process a DELETE request, the user_id and delete_images variables must be specified. The user_id value for the member is found in the users_data table of the website. If the value of delete_images is set to 1, the image files related to the member will also be deleted from the site. If the value of delete_images is anything other than 1, the member’s related image files will not be deleted.

Example cURL request to this endpoint:

curl -X 'DELETE' \
  'https://mywebsite.com/api/v2/user/delete' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: myapikey' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'user_id=1&delete_images=1'

/api/v2/token/verify

HTTP request method: GET

This endpoint accepts GET requests to verify if an API Key is valid. Replace “mypikey” with the API Key to test.

Example cURL request to this endpoint:

curl -X 'GET' \
  'https://mywebsite.com/api/v2/token/verify' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: myapikey'

Response Messages

Each request returns a JSON string with the response along with one of several response codes.

Example response:

{
  "status": "error",
  "message": "API Key is invalid"
}

The key “status” can have one of 2 values: error, or success. The value of the “message” when the status is “error” will explain the reason for the error.

When the “status” is “success”, the “message” will either contain an object for requests to the /api/v2/get/{user_id} endpoint, or more details about the successful request for other endpoints.

Some examples regarding this can be found down below.

Error Response:

{
  "status": "error",
  "message": "No password specified for the user"
}

Success Response:

{
  "status": "success",
  "message": {
    "website": "https://mywebsite.com",
    "key": "My API Key Name"
  }
}

Response Codes

Here is the list of HTTP response codes that may be returned for requests.

200

{
  "status": "success",
  "message": {
    "website": "https://mywebsite.com",
    "key": "My API Key Name"
  }
}

400

{
  "status": "error",
  "message": "API Key is invalid"
}

405

{
  "status": "error",
  "message": "Invalid Request Method"
}

429

{
  "status": "error",
  "message": "Too many API requests per minute"
}

More examples and test cases can be found in the API Testing Page:

What Do You Need Help With?

API Overview and Testing the API From Admin Area

API Endpoints

/api/v2/user/get/{user_id}

/api/v2/user/create

/api/v2/user/delete

/api/v2/token/verify

Response Messages

Error Response:

Success Response:

Response Codes

200

400

405

429

Related Articles