Wiki

    Contact support:

    Email: support@erply.com

    23 Sep, 2021
    Permalink:
    Also available in:EstonianFinnish

    Authentication API

    Authentication API contains calls for interactive login flows — including two-factor authentication, Single Sign-On with identity providers, and switching user with a PIN.

    It also contains calls for initiating a password reset.

    In a custom integration, you do not typically need to implement these login flows. If you want to build a custom back office report, you can rely on the user already being logged in, and you can use their existing session key.

    A standalone integration can authenticate with the verifyUser call.

    Usage

    To find the endpoint specific for your account, use the "getServiceEndpoints" call.

    Each endpoint provides Swagger documentation. For an example, see the documentation provided by the sandbox endpoint:

    https://api-auth-eu10.erply.com/documentation/index.html#/

    Use an Erply client code and API session key to make requests. (Send these as headers "clientCode" and "sessionKey".)