API users - How to update your login method

If you built an integration with OnePageCRM using the API login endpoint (Legacy), you're currently using an outdated login method.

To enable our 2-factor authentication feature without breaking your API integration with OnePageCRM, you will need to first update your code to log in via HTTP Basic Authentication

The main difference between these two login methods is that the API login endpoint (Legacy) uses  login   and password  to access OnePageCRM while HTTP Basic Authentication uses user_id  and api_key .

To keep your integration code working, you need to switch to HTTP Basic Authentication. See sample codes here:

https://github.com/OnePageCRM/java-wrapper

https://github.com/OnePageCRM/kotlin-sample

https://github.com/OnePageCRM/php-sample

https://github.com/OnePageCRM/ruby-client

https://github.com/OnePageCRM/python-sample

How to find your API key

1
Select your User/Profile icon (top-right corner) → Apps and Integrations → under Utilities select API.

Apps and Integrations | Utilities | API

2
Select the Configuration tabShow API key.

API Configuration tab | next to API key > Select Show API key

Notes:

  • You can generate a new API key if needed by selecting Generate new API key.
  • If you have any queries relating to the API, please contact our Dev Team directly here.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us