How to get started

Get your Operator Id

Once your operator is set up by Owens we will provide an operatorId which will be used for calling the APIs. OperatorId is just used by Owens to differentiate multiple sub-operators. most of the time there will be a single operator For the test environment operator Id will be 1

Integrating the client's login system with Owens

Once the user is logged in on the client's platform client's backend needs to call our following API by passing the user's access token. user/onboard/{operatorId} Login type will be 5 and the user's access token of the client's platform need to be passed into data

Owens also needs a GET API (user detail API) from the client that will take the access token in the header ( accessToken) and after verifying that access token that API will return the user details. The detail must include the email of the user. Once the client's API verified the access token with the required details Owens's onboard API will return Owens's JWT access token. Now client's backend can call any API on the user's behalf by passing this access token.

Good to know: Owens also provides a standalone onboarding process using email/phone and OTP along with social logins like Facebook and Gamil

Calling internal APIs

Internal APIs are those APIs which cannot be called by a user.

You can check roles & privileges for more details on internal APIs

To call internal APIs you need an API key, just like the operatorId Owens will also provide you with the API key once the setup will be done. But unlike operatorId, the API key should not be shared with anyone, and internal APIs should not be called from the front end. API key(apiKey) should be passed in the header while calling internal APIs

Last updated