scroll

PORTERS Connect API Termination of Use Request

To terminate the use of the API, please submit your request using the form below. 

Please make sure that the request is submitted by the PORTERS user company that has the API contract.
Also, if we feel that confirmation is necessary, we may contact the applicant or the PORTERS contract representative before proceeding. Thank you for your understanding.

■ Important! Please be sure to confirm the following.

  • If you wish to terminate usage within the current month, please submit your request at least three business days before the last business day of the month.
  • If you submit your request outside of business hours, it will be received on the next business day.
  • If the request is submitted after the end of the month, the API usage fee for the following month will be charged.

    Example: You wish to terminate usage at the end of July 2016 (month-end falls on a weekend)

    • Request submitted on Tuesday, July 26
      If there are no issues with the request, the procedure will be completed by July 29.
    • Request submitted between 6:00 PM on Friday, July 29 and Sunday, July 31
      Request will be received on the next business day, August 1, and the procedure will be completed on or after August 2, resulting in API usage charges for August.

     

  • Please read What to do when ending API use and take the necessaryr If the actions are not completed, you may be subject to monthly API usage fees and access-based charges.
     
  • Notification emails regarding request receipt and procedure completion will be sent from
    Sender: "hrbcapi-support@porters.jp"
    If you have spam filters enabled, please ensure that you can receive emails from the above address.

 

 

What to do when ending API use

Before the application usage end date, we kindly ask that you complete the following actions a) and b).

■ a) Please ensure that no access related to the API occurs. (Required)


Regardless of the content, please ensure that no access (requests) using PORTERS Connect API occurs from mechanisms related to the target application.
Please make sure that all such operations are stopped.
 

If access (requests) occurs within the same month including the usage end date and after the usage end date,
PORTERS Connect API will return an error,
but such processing will still place a load on our server, and will be counted as one API access for the month and charged accordingly.
 

However, we do not wish to impose irrational or unjustified charges for this reason,
so please make sure to take action "before the usage end date".

 

■ b) Please delete access permissions to the Company DB. (Optional)


This operation means deleting access permissions to the database of your PORTERS environment from the relevant application.
After this operation, the application will no longer be able to retrieve or write data to the target database.
 

Even if this operation is not performed, PORTERS Corporation will forcibly delete access permissions at some point after the application usage end date.
(The timing cannot be guaranteed, and we may not be able to notify you when it is performed)
 

Therefore, although optional, we recommend performing this operation "before the usage end date" and "when you determine that the application will no longer be used" from a security perspective.
 

For details on the necessary steps to delete access permissions to the Company DB, please refer to the following page. (Please note that the explanation is intended for developers.)

OAuth -> Authentication Sequence : remove

Alternatively, please continue reading below for supplementary information.



Note that this operation does not necessarily have to be performed by the developer.
Even those without technical expertise can perform this operation.
Below are typical operation steps for your reference.

Before performing the operation, please make sure that it is safe to do so (i.e., that it is acceptable for the application to stop functioning).

 

…The operation is very simple.
Enter the following URL into your browser’s address bar and follow the on-screen instructions.
Log in if necessary (using your PORTERS login credentials) and approve the deletion of access permissions.

{Request Host URL}/v1/oauth?response_type=remove&app_id=[App Id]&scope=partition_r,user_r,field_r,option_r,client_r,client_w,recruiter_r,recruiter_w,contact_r,contact_w,job_r,job_w,candidate_r,candidate_w,resume_r,resume_w,process_r,process_w,activity_r,activity_w,contract_r,contract_w,sales_r,sales_w,phase_r,phase_w,attachment_r,attachment_w,opportunity_r,opportunity_w&redirect_url=[Redirect URL]
  • {Request Host URL}
    If you have a dedicated server, enter the URL of that server.
    Normally, use the shared server "https://api-hrbc-jp.porterscloud.com". If unsure, please try this.
     
  • [App Id]
    Enter the "App ID" issued at the time of application registration.
    (During the API registration process, we sent you a notification email containing the relevant details.)
     
  • [Redirect URL]
    Enter the "Redirect URL" specified at the time of application registration.
    (During the API registration process, we sent you a notification email containing the relevant details.)

Example: If the connection information for the application is as follows

  • [App Id] : xxxxxx
  • [Redirect URL] : http://zzzzzz.com


https://api-hrbc-jp.porterscloud.com/v1/oauth?response_type=remove&app_id=xxxxxx&scope=partition_r,user_r,field_r,option_r,client_r,client_w,recruiter_r,recruiter_w,contact_r,contact_w,job_r,job_w,candidate_r,candidate_w,resume_r,resume_w,process_r,process_w,activity_r,activity_w,contract_r,contract_w,sales_r,sales_w,phase_r,phase_w,attachment_r,attachment_w,opportunity_r,opportunity_w&redirect_url=http://zzzzzz.com

Was this article helpful?
0 out of 0 found this helpful