Darwinbox
4 min
this guide walks you through connecting your darwinbox instance to bindbee darwinbox apis are restricted to privileged users and are granted on a request basis, so reach out to your darwinbox account manager for your credentials before you begin you will need an active darwinbox account, and a named contact at darwinbox (your account manager or customer success representative) who can raise the request internally the values that must be provided via the magic link to successfully set up the connection\ v value where it comes from tenant (subdomain) your darwinbox url region your darwinbox url username your darwinbox rep password your darwinbox rep api key + dataset key (active employees) your darwinbox rep api key + dataset key (inactive employees) your darwinbox rep finding your tenant and region step 1 sign in to darwinbox and look at the address bar your url follows the pattern https //\<subdomain> \<domain>/ step 2 the tenant (subdomain) is the text after https // and before the first dot for example, in https //acmecorp darwinbox in/ , the tenant is acmecorp step 3 the region is the domain your instance is hosted on, which is the part after the first dot, for example darwinbox in or darwinbox com select the option in bindbee that matches your url exactly requesting your credentials from darwinbox step 4 raise a request with your darwinbox account manager saying you are enabling an api integration with a third party platform, and ask them to provide a username and password for an integration user an api key and dataset key for all active employees an api key and dataset key for all inactive employees ask for the integration user to be a dedicated service account rather than a named employee's login a personal login will break the connection the moment that person leaves or has their access changed the active and inactive employee datasets are issued as separate key pairs if you only receive one pair, please confirm which dataset it covers step 5 in the same request, make sure that all the required scopes are enabled step 6 store the credentials somewhere secure when they arrive entering the credentials in bindbee step 7 in the bindbee authorization flow, enter your tenant (subdomain) , region , username , and password , then continue step 8 enter the api key and dataset key for active employees step 9 enter the api key and dataset key for inactive employees , then submit bindbee validates the credentials immediately and begins the first sync once they pass troubleshooting symptom likely cause authentication error on submit wrong username or password, or the api keys were not issued against that integration user connection succeeds but no employees return the keys were issued against the wrong module or endpoint they need to cover the core module and the /masterapi/employee endpoint employees sync but fields are blank the required fields are not enabled for your masterapi please contact your representative to enable the necessary scopes